Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
KFMCTrack Class Reference

A class for storage of the Monte Carlo simulated track in the cartesian parametrisation. More...

#include <KFParticle/blob/master/KFParticlePerformance/KFMCTrack.h>

Public Member Functions

 KFMCTrack ()
 
int MotherId () const
 Returns a uniqueue Id of the mother track or primary vertex KFMCTrack::fMotherId.
 
int PDG () const
 Returns PDG code of the track KFMCTrack::fPDG.
 
float Par (int i) const
 Returns value of the parameter KFMCTrack::fPar with index "i".
 
float X () const
 Returns X coordinate of the track at the origin position.
 
float Y () const
 Returns Y coordinate of the track at the origin position.
 
float Z () const
 Returns Y coordinate of the track at the origin position.
 
float L () const
 Returns distance from the origin of the track to a point {0,0,0}.
 
float Px () const
 Returns Px momentum component of the track at the origin position.
 
float Py () const
 Returns Py momentum component of the track at the origin position.
 
float Pz () const
 Returns Pz momentum component of the track at the origin position.
 
float P () const
 Returns momentum of the track.
 
float Pt () const
 Returns transverse momentum of the track.
 
const float * Par () const
 Returns a pointer to the array with track parameters KFMCTrack::fPar.
 
int NMCPoints () const
 Returns number of MC points KFMCTrack::fNMCPoints.
 
int NMCPixelPoints () const
 Returns number of MC points at the precise detectors KFMCTrack::fNMCPixelPoints.
 
bool IsReconstructed () const
 Returns a flag showing if track was found by the reconstruction procedure.
 
bool IsOutOfDetector () const
 Returns a flag showing if track was out of acceptance.
 
void SetPar (int i, float v)
 Sets a value "v" to the parameter with index "i".
 
void SetX (float v)
 Sets X coordinate at the origin position of the track.
 
void SetY (float v)
 Sets Y coordinate at the origin position of the track.
 
void SetZ (float v)
 Sets Z coordinate at the origin position of the track.
 
void SetPx (float v)
 Sets Px momentum component at the origin position of the track.
 
void SetPy (float v)
 Sets Py momentum component at the origin position of the track.
 
void SetPz (float v)
 Sets Pz momentum component at the origin position of the track.
 
void SetQP (float v)
 Sets q/P at the origin position of the track.
 
void SetMotherId (int v)
 Sets a unique id of the mother track if track is secondary or primary vertex with a negative sign if it is primary.
 
void SetPDG (int v)
 Sets PDG code of the current track.
 
void SetNMCPoints (int v)
 Sets number of MC points produced at the detector planes.
 
void SetNMCPixelPoints (int v)
 Sets number of the MC points produced at the precise detectors.
 
void SetReconstructed ()
 Defines the track as reconstructed.
 
void SetNotReconstructed ()
 Defines the track as not reconstructed.
 
void SetOutOfDetector ()
 Defines the track out of acceptance.
 

Protected Attributes

int fMotherId
 Index of the mother track in tracks array. If track is produced at the primary vertex (PV) negative value with the PV Id is assigned.
 
int fPDG
 The PDG code of the current Monte Carlo track.
 
float fPar [7]
 Parameters of the track: { X, Y, Z, Px, Py, Pz, q/P }, where "q" is its charge.
 
int fNMCPoints
 Total number of Monte Carlo points produced by the simulation engine at the detector stations.
 
int fNMCPixelPoints
 Number of Monte Carlo points produced at the precise detectors (like MVD in CBM, HFT in STAR, ITS in ALICE, etc.).
 
bool fIsReconstructed
 A flag showing if track was found by the reconstruction procedure. Is required for correct efficiency calculation.
 
bool fIsOutOfDetector
 A flag showing if track was out of acceptance. Is required for correct calculation of the acceptance.
 

Detailed Description

A class for storage of the Monte Carlo simulated track in the cartesian parametrisation.

Author
M.Zyzak, I.Kisel
Date
05.02.2019
Version
1.0

A track is described with the parameters { X, Y, Z, Px, Py, Pz, q/P }. Parameters are stored at the origin position. Class also contains Id of the mother track, PDG code for the current track, number of Monte Carlo points produced by the simulation engine at the detector stations, number of Monte Carlo points produced at the precise detectors (like MVD in CBM, HFT in STAR, ITS in ALICE, etc.). It also has a flag showing if track was found by the reconstruction procedure for efficiency calculation, and a flag showing if track was out of acceptance.

Definition at line 41 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 41 of file KFMCTrack.h

Constructor & Destructor Documentation

KFMCTrack::KFMCTrack ( )
inline

Definition at line 44 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 44 of file KFMCTrack.h

Member Function Documentation

bool KFMCTrack::IsOutOfDetector ( ) const
inline

Returns a flag showing if track was out of acceptance.

Definition at line 62 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 62 of file KFMCTrack.h

References fIsOutOfDetector.

bool KFMCTrack::IsReconstructed ( ) const
inline

Returns a flag showing if track was found by the reconstruction procedure.

Definition at line 61 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 61 of file KFMCTrack.h

References fIsReconstructed.

float KFMCTrack::L ( ) const
inline

Returns distance from the origin of the track to a point {0,0,0}.

Definition at line 52 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 52 of file KFMCTrack.h

References X(), Y(), and Z().

+ Here is the call graph for this function:

int KFMCTrack::MotherId ( ) const
inline

Returns a uniqueue Id of the mother track or primary vertex KFMCTrack::fMotherId.

Definition at line 46 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 46 of file KFMCTrack.h

References fMotherId.

int KFMCTrack::NMCPixelPoints ( ) const
inline

Returns number of MC points at the precise detectors KFMCTrack::fNMCPixelPoints.

Definition at line 60 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 60 of file KFMCTrack.h

References fNMCPixelPoints.

int KFMCTrack::NMCPoints ( ) const
inline

Returns number of MC points KFMCTrack::fNMCPoints.

Definition at line 59 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 59 of file KFMCTrack.h

References fNMCPoints.

float KFMCTrack::P ( ) const
inline

Returns momentum of the track.

Definition at line 56 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 56 of file KFMCTrack.h

References fPar.

float KFMCTrack::Par ( int  i) const
inline

Returns value of the parameter KFMCTrack::fPar with index "i".

Definition at line 48 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 48 of file KFMCTrack.h

References fPar, and i.

const float* KFMCTrack::Par ( ) const
inline

Returns a pointer to the array with track parameters KFMCTrack::fPar.

Definition at line 58 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 58 of file KFMCTrack.h

References fPar.

int KFMCTrack::PDG ( ) const
inline

Returns PDG code of the track KFMCTrack::fPDG.

Definition at line 47 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 47 of file KFMCTrack.h

References fPDG.

float KFMCTrack::Pt ( ) const
inline

Returns transverse momentum of the track.

Definition at line 57 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 57 of file KFMCTrack.h

References fPar.

float KFMCTrack::Px ( ) const
inline

Returns Px momentum component of the track at the origin position.

Definition at line 53 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 53 of file KFMCTrack.h

References fPar.

float KFMCTrack::Py ( ) const
inline

Returns Py momentum component of the track at the origin position.

Definition at line 54 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 54 of file KFMCTrack.h

References fPar.

float KFMCTrack::Pz ( ) const
inline

Returns Pz momentum component of the track at the origin position.

Definition at line 55 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 55 of file KFMCTrack.h

References fPar.

void KFMCTrack::SetMotherId ( int  v)
inline

Sets a unique id of the mother track if track is secondary or primary vertex with a negative sign if it is primary.

Definition at line 72 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 72 of file KFMCTrack.h

References fMotherId, and testSigmaEff::v.

void KFMCTrack::SetNMCPixelPoints ( int  v)
inline

Sets number of the MC points produced at the precise detectors.

Definition at line 75 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 75 of file KFMCTrack.h

References fNMCPixelPoints, and testSigmaEff::v.

void KFMCTrack::SetNMCPoints ( int  v)
inline

Sets number of MC points produced at the detector planes.

Definition at line 74 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 74 of file KFMCTrack.h

References fNMCPoints, and testSigmaEff::v.

void KFMCTrack::SetNotReconstructed ( )
inline

Defines the track as not reconstructed.

Definition at line 77 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 77 of file KFMCTrack.h

References fIsReconstructed.

void KFMCTrack::SetOutOfDetector ( )
inline

Defines the track out of acceptance.

Definition at line 78 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 78 of file KFMCTrack.h

References fIsOutOfDetector.

void KFMCTrack::SetPar ( int  i,
float  v 
)
inline

Sets a value "v" to the parameter with index "i".

Definition at line 64 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 64 of file KFMCTrack.h

References fPar, i, and testSigmaEff::v.

void KFMCTrack::SetPDG ( int  v)
inline

Sets PDG code of the current track.

Definition at line 73 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 73 of file KFMCTrack.h

References fPDG, and testSigmaEff::v.

void KFMCTrack::SetPx ( float  v)
inline

Sets Px momentum component at the origin position of the track.

Definition at line 68 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 68 of file KFMCTrack.h

References fPar, and testSigmaEff::v.

void KFMCTrack::SetPy ( float  v)
inline

Sets Py momentum component at the origin position of the track.

Definition at line 69 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 69 of file KFMCTrack.h

References fPar, and testSigmaEff::v.

void KFMCTrack::SetPz ( float  v)
inline

Sets Pz momentum component at the origin position of the track.

Definition at line 70 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 70 of file KFMCTrack.h

References fPar, and testSigmaEff::v.

void KFMCTrack::SetQP ( float  v)
inline

Sets q/P at the origin position of the track.

Definition at line 71 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 71 of file KFMCTrack.h

References fPar, and testSigmaEff::v.

void KFMCTrack::SetReconstructed ( )
inline

Defines the track as reconstructed.

Definition at line 76 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 76 of file KFMCTrack.h

References fIsReconstructed.

void KFMCTrack::SetX ( float  v)
inline

Sets X coordinate at the origin position of the track.

Definition at line 65 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 65 of file KFMCTrack.h

References fPar, and testSigmaEff::v.

void KFMCTrack::SetY ( float  v)
inline

Sets Y coordinate at the origin position of the track.

Definition at line 66 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 66 of file KFMCTrack.h

References fPar, and testSigmaEff::v.

void KFMCTrack::SetZ ( float  v)
inline

Sets Z coordinate at the origin position of the track.

Definition at line 67 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 67 of file KFMCTrack.h

References fPar, and testSigmaEff::v.

float KFMCTrack::X ( ) const
inline

Returns X coordinate of the track at the origin position.

Definition at line 49 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 49 of file KFMCTrack.h

References fPar.

Referenced by L().

+ Here is the caller graph for this function:

float KFMCTrack::Y ( ) const
inline

Returns Y coordinate of the track at the origin position.

Definition at line 50 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 50 of file KFMCTrack.h

References fPar.

Referenced by L().

+ Here is the caller graph for this function:

float KFMCTrack::Z ( ) const
inline

Returns Y coordinate of the track at the origin position.

Definition at line 51 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 51 of file KFMCTrack.h

References fPar.

Referenced by L().

+ Here is the caller graph for this function:

Member Data Documentation

bool KFMCTrack::fIsOutOfDetector
protected

A flag showing if track was out of acceptance. Is required for correct calculation of the acceptance.

Definition at line 89 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 89 of file KFMCTrack.h

Referenced by IsOutOfDetector(), and SetOutOfDetector().

bool KFMCTrack::fIsReconstructed
protected

A flag showing if track was found by the reconstruction procedure. Is required for correct efficiency calculation.

Definition at line 88 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 88 of file KFMCTrack.h

Referenced by IsReconstructed(), SetNotReconstructed(), and SetReconstructed().

int KFMCTrack::fMotherId
protected

Index of the mother track in tracks array. If track is produced at the primary vertex (PV) negative value with the PV Id is assigned.

Definition at line 82 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 82 of file KFMCTrack.h

Referenced by MotherId(), and SetMotherId().

int KFMCTrack::fNMCPixelPoints
protected

Number of Monte Carlo points produced at the precise detectors (like MVD in CBM, HFT in STAR, ITS in ALICE, etc.).

Definition at line 86 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 86 of file KFMCTrack.h

Referenced by NMCPixelPoints(), and SetNMCPixelPoints().

int KFMCTrack::fNMCPoints
protected

Total number of Monte Carlo points produced by the simulation engine at the detector stations.

Definition at line 85 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 85 of file KFMCTrack.h

Referenced by NMCPoints(), and SetNMCPoints().

float KFMCTrack::fPar[7]
protected

Parameters of the track: { X, Y, Z, Px, Py, Pz, q/P }, where "q" is its charge.

Definition at line 84 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 84 of file KFMCTrack.h

Referenced by P(), Par(), Pt(), Px(), Py(), Pz(), SetPar(), SetPx(), SetPy(), SetPz(), SetQP(), SetX(), SetY(), SetZ(), X(), Y(), and Z().

int KFMCTrack::fPDG
protected

The PDG code of the current Monte Carlo track.

Definition at line 83 of file KFMCTrack.h.

View newest version in sPHENIX GitHub at line 83 of file KFMCTrack.h

Referenced by PDG(), and SetPDG().


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