ATLAS Offline Software
Loading...
Searching...
No Matches
xAOD::AFPVertex_v1 Class Reference

Class representing a vertex reconstructed in AFP. More...

#include <AFPVertex_v1.h>

Inheritance diagram for xAOD::AFPVertex_v1:
Collaboration diagram for xAOD::AFPVertex_v1:

Public Types

typedef ElementLink< AFPProtonContainerAFPProtonLink_t
 Type of a link to the proton.
typedef ElementLink< AFPToFTrackContainerAFPToFTrackLink_t
 Type of a link to the tofTrack.

Public Member Functions

float position () const
 Vertex position .
void setPosition (float newPosition)
 Set vertex position.
const std::vector< AFPProtonLink_t > & protons () const
 Vector of links to protons that were used to reconstruct vertex.
void setProtons (const std::vector< AFPProtonLink_t > &newProtonsVector)
 Set vector of links to protons used for vertex reconstruction.
void addProton (const AFPProtonLink_t &newProton)
 Add a link to a proton used to reconstruct the vertex.
const std::vector< AFPToFTrackLink_t > & tofTracks () const
 Vector of links to ToFTracks that were used to reconstruct vertex.
void setToFTracks (const std::vector< AFPToFTrackLink_t > &newToFTracksVector)
 Set vector of links to ToFTracks used for vertex reconstruction.
void addToFTrack (const AFPToFTrackLink_t &newToFTrack)
 Add a link to a ToFTrack used to reconstruct the vertex.
float distA () const
 Distance of the proton to the selected ToFTracks.
float distC () const
void setDistA (float newDistA)
 Set \(\chi^2\) value of the prootn fit to the selected ToFTracks.
void setDistC (float newDistC)
int algID () const
 Identification number of the algorithm used to reconstruct the vertex.
void setAlgID (int newIAlgID)
 Set reconstruction algorithm identification number.
void toPersistent ()
 Function making sure that the object is ready for persistification i.e. saving.

Detailed Description

Class representing a vertex reconstructed in AFP.

This class provides access to the information about vertices that were reconstructed using AFP information.

Definition at line 40 of file AFPVertex_v1.h.

Member Typedef Documentation

◆ AFPProtonLink_t

Type of a link to the proton.

Definition at line 45 of file AFPVertex_v1.h.

◆ AFPToFTrackLink_t

Type of a link to the tofTrack.

Definition at line 48 of file AFPVertex_v1.h.

Member Function Documentation

◆ addProton()

void xAOD::AFPVertex_v1::addProton ( const AFPProtonLink_t & newProton)

Add a link to a proton used to reconstruct the vertex.

A new link to the proton is added to the existing vector of links to the protons used to reconstruct the vertex.

Parameters
newProtonlink to the proton used to reconstruct the vertex

Definition at line 37 of file AFPVertex_v1.cxx.

38 {
39
40 if (not protonsAcc.isAvailable( *this ) )
41 protonsAcc( *this ) = std::vector<AFPVertex_v1::AFPProtonLink_t>();
42 protonsAcc( *this ).push_back( link );
43 return;
44 }
static const SG::AuxElement::Accessor< std::vector< AFPVertex_v1::AFPProtonLink_t > > protonsAcc("protons")

◆ addToFTrack()

void xAOD::AFPVertex_v1::addToFTrack ( const AFPToFTrackLink_t & newToFTrack)

Add a link to a ToFTrack used to reconstruct the vertex.

A new link to the ToFTrack is added to the existing vector of links to the ToFTrackss used to reconstruct the vertex.

Parameters
newToFTracklink to the ToFTrack used to reconstruct the vertex

Definition at line 46 of file AFPVertex_v1.cxx.

47 {
48 if (not tofTracksAcc.isAvailable( *this ) )
49 tofTracksAcc( *this ) = std::vector<AFPVertex_v1::AFPToFTrackLink_t>();
50 tofTracksAcc( *this ).push_back( link );
51 return;
52 }
static const SG::AuxElement::Accessor< std::vector< AFPVertex_v1::AFPToFTrackLink_t > > tofTracksAcc("tofTracks")

◆ algID()

int xAOD::AFPVertex_v1::algID ( ) const

Identification number of the algorithm used to reconstruct the vertex.

The following coding is used.

ID Algorithm Comments
0 Basic algorithm
Returns
identification number of the algorithm used to reconstruct the track

◆ distA()

float xAOD::AFPVertex_v1::distA ( ) const

Distance of the proton to the selected ToFTracks.

This value gives information about how well the proton trajectory matches on the selected ToFTracks.

return distance of the track to the selected ToFTrack

◆ distC()

float xAOD::AFPVertex_v1::distC ( ) const

◆ position()

float xAOD::AFPVertex_v1::position ( ) const

Vertex position .

@copydetail xAOD::AFPVertex_v1::position()

◆ protons()

const std::vector< AFPProtonLink_t > & xAOD::AFPVertex_v1::protons ( ) const

Vector of links to protons that were used to reconstruct vertex.

This method provides access to the protons that were used to reconstruct the vertex via ElementLink object.

Note
Returns

◆ setAlgID()

void xAOD::AFPVertex_v1::setAlgID ( int newIAlgID)

Set reconstruction algorithm identification number.

The following coding is used.

ID Algorithm Comments
0 Basic algorithm
Returns
identification number of the algorithm used to reconstruct the track
Parameters
newIAlgIDidentification number of the algorithm used to reconstruct the vertex

◆ setDistA()

void xAOD::AFPVertex_v1::setDistA ( float newDistA)

Set \(\chi^2\) value of the prootn fit to the selected ToFTracks.

Parameters
newFChi2\(\chi^2\) value of the proton fit to the selected ToFTrackss

◆ setDistC()

void xAOD::AFPVertex_v1::setDistC ( float newDistC)

◆ setPosition()

void xAOD::AFPVertex_v1::setPosition ( float newPosition)

Set vertex position.

@copydetail xAOD::AFPVertex_v1::position()

Parameters
newPositionvertex

◆ setProtons()

void xAOD::AFPVertex_v1::setProtons ( const std::vector< AFPProtonLink_t > & newProtonsVector)

Set vector of links to protons used for vertex reconstruction.

Parameters
newProtonsVectorvector of links to protons used for vertex reconstruction

◆ setToFTracks()

void xAOD::AFPVertex_v1::setToFTracks ( const std::vector< AFPToFTrackLink_t > & newToFTracksVector)

Set vector of links to ToFTracks used for vertex reconstruction.

Parameters
newToFTracksVectorvector of links to ToFTracks used for vertex reconstruction

◆ tofTracks()

const std::vector< AFPToFTrackLink_t > & xAOD::AFPVertex_v1::tofTracks ( ) const

Vector of links to ToFTracks that were used to reconstruct vertex.

This method provides access to the ToFTracks that were used to reconstruct the vertex via ElementLink object.

Note
Returns

◆ toPersistent()

void xAOD::AFPVertex_v1::toPersistent ( )

Function making sure that the object is ready for persistification i.e. saving.

Definition at line 54 of file AFPVertex_v1.cxx.

54 {
55 // Prepare the protons links for persistification:
56 if( protonsAcc.isAvailableWritable( *this ) ) {
57 for (AFPProtonLink_t link : protonsAcc( *this )) link.toPersistent();
58 }
59 // Prepare the tofTrackss links for persistification:
60 if( tofTracksAcc.isAvailableWritable( *this ) ) {
61 for (AFPToFTrackLink_t link : tofTracksAcc( *this )) link.toPersistent();
62 }
63 return;
64 }
ElementLink< AFPProtonContainer > AFPProtonLink_t
Type of a link to the proton.
ElementLink< AFPToFTrackContainer > AFPToFTrackLink_t
Type of a link to the tofTrack.
pointer & link(pointer p) const
Return a reference to the link for an element.

The documentation for this class was generated from the following files: