Belle II Software  release-05-02-19
TrackingAction Class Reference

The Tracking Action class. More...

#include <TrackingAction.h>

Inheritance diagram for TrackingAction:
Collaboration diagram for TrackingAction:

Public Member Functions

 TrackingAction (MCParticleGraph &mcParticleGraph)
 Constructor. More...
 
virtual ~TrackingAction ()
 Destructor.
 
void PreUserTrackingAction (const G4Track *track)
 Checks if the particle associated to the track is already in the MCParticle list. More...
 
void PostUserTrackingAction (const G4Track *track)
 Updates the data of the MCParticle associated with the Geant4 track. More...
 
void setIgnoreOpticalPhotons (bool ignore=true)
 Set ignore flag for optical photons if set to true, optical photons will not be stored in MCParticles collection. More...
 
void setIgnoreSecondaries (bool ignore=true)
 Set ignore flag for low energy Geant-produced secondary particles if set to true, secondaries with kinetic energy above SecondariesEnergyCut will be stored in the MCParticles collection. More...
 
void setSecondariesEnergyCut (double cut_MeV)
 Set kinetic energy cut for secondaries. More...
 
void setIgnoreBremsstrahlungPhotons (bool ignore=true)
 Set ignore flag for low energy breamsstrahlung photons if set to true, breamsstrahlung photons with kinetic energy above BremsStrahlungPhotonsEnergyCut will be stored in the MCParticles collection, even if IgnoreSecondaries flag is true. More...
 
void setBremsstrahlungPhotonsEnergyCut (double cut_MeV)
 Set kinetic energy cut for bremsstrahlung photons. More...
 
void setIgnorePairConversions (bool ignore=true)
 Set ignore flag for e+ or e- coming from gamma conversions into a pair if set to true, e+ or e- from pair conversions with kinetic energy above PairConversionsEnergyCut will be stored in the MCParticles collection, even if IgnoreSecondaries flag is true. More...
 
void setPairConversionsEnergyCut (double cut_MeV)
 Set kinetic energy cut for e+ e- pair conversions. More...
 
void setStoreTrajectories (int store, double distanceTolerance)
 Sets the trajectory option to enable storing of the simulated particle trajectories.
 

Protected Attributes

MCParticleGraphm_mcParticleGraph
 < Reference to the MCParticle graph which is updated by the tracking action.
 
bool m_ignoreOpticalPhotons
 do not store optical photons in MCParticles
 
bool m_ignoreSecondaries
 do not store secondaries in MCParticles
 
double m_secondariesEnergyCut
 kinetic energy cut for stored secondaries [MeV]
 
bool m_ignoreBremsstrahlungPhotons
 do not store bremsstrahlung photons in MCParticles
 
double m_bremsstrahlungPhotonsEnergyCut
 kinetic energy cut for stored bremsstrahlung photons [MeV]
 
bool m_ignorePairConversions
 do not store e+ or e- from pair conversions in MCparticles
 
double m_pairConversionsEnergyCut
 kinetic energy cut for stored e+ or e- from pair conversions [MeV]
 
int m_storeTrajectories
 Store trajectories for 0=none, 1=primary or 2=all particles.
 
double m_distanceTolerance
 distance tolerance to merge trajectory points
 
StoreArray< MCParticleTrajectorym_storeMCTrajectories
 Store array for the Trajectories.
 
RelationArray m_relMCTrajectories
 RelationArry for the relation between MCParticles and Trajectories.
 

Detailed Description

The Tracking Action class.

Definition at line 40 of file TrackingAction.h.

Constructor & Destructor Documentation

◆ TrackingAction()

TrackingAction ( MCParticleGraph mcParticleGraph)
explicit

Constructor.

Parameters
mcParticleGraphReference to the MCParticle graph which is used to add secondary particles.

Definition at line 29 of file TrackingAction.cc.

Member Function Documentation

◆ PostUserTrackingAction()

void PostUserTrackingAction ( const G4Track *  track)

Updates the data of the MCParticle associated with the Geant4 track.

Parameters
trackPointer to the Geant4 track which was transported through the geometry.

Definition at line 145 of file TrackingAction.cc.

◆ PreUserTrackingAction()

void PreUserTrackingAction ( const G4Track *  track)

Checks if the particle associated to the track is already in the MCParticle list.

If not, the particle is added and as UserInformation attached to the track.

Parameters
trackPointer to the Geant4 track which will be transported through the geometry.

Definition at line 60 of file TrackingAction.cc.

◆ setBremsstrahlungPhotonsEnergyCut()

void setBremsstrahlungPhotonsEnergyCut ( double  cut_MeV)
inline

Set kinetic energy cut for bremsstrahlung photons.

Parameters
cut_MeVkinetic energy in MeV

Definition at line 102 of file TrackingAction.h.

102 {m_ignorePairConversions = ignore;}

◆ setIgnoreBremsstrahlungPhotons()

void setIgnoreBremsstrahlungPhotons ( bool  ignore = true)
inline

Set ignore flag for low energy breamsstrahlung photons if set to true, breamsstrahlung photons with kinetic energy above BremsStrahlungPhotonsEnergyCut will be stored in the MCParticles collection, even if IgnoreSecondaries flag is true.

Parameters
ignoreflag

Definition at line 96 of file TrackingAction.h.

◆ setIgnoreOpticalPhotons()

void setIgnoreOpticalPhotons ( bool  ignore = true)
inline

Set ignore flag for optical photons if set to true, optical photons will not be stored in MCParticles collection.

Parameters
ignoreflag

Definition at line 75 of file TrackingAction.h.

◆ setIgnorePairConversions()

void setIgnorePairConversions ( bool  ignore = true)
inline

Set ignore flag for e+ or e- coming from gamma conversions into a pair if set to true, e+ or e- from pair conversions with kinetic energy above PairConversionsEnergyCut will be stored in the MCParticles collection, even if IgnoreSecondaries flag is true.

Parameters
ignoreflag

Definition at line 110 of file TrackingAction.h.

◆ setIgnoreSecondaries()

void setIgnoreSecondaries ( bool  ignore = true)
inline

Set ignore flag for low energy Geant-produced secondary particles if set to true, secondaries with kinetic energy above SecondariesEnergyCut will be stored in the MCParticles collection.

Parameters
ignoreflag

Definition at line 82 of file TrackingAction.h.

◆ setPairConversionsEnergyCut()

void setPairConversionsEnergyCut ( double  cut_MeV)
inline

Set kinetic energy cut for e+ e- pair conversions.

Parameters
cut_MeVkinetic energy in MeV

Definition at line 116 of file TrackingAction.h.

◆ setSecondariesEnergyCut()

void setSecondariesEnergyCut ( double  cut_MeV)
inline

Set kinetic energy cut for secondaries.

Parameters
cut_MeVkinetic energy in MeV

Definition at line 88 of file TrackingAction.h.


The documentation for this class was generated from the following files:
Belle2::Simulation::TrackingAction::m_storeMCTrajectories
StoreArray< MCParticleTrajectory > m_storeMCTrajectories
Store array for the Trajectories.
Definition: TrackingAction.h:140
Belle2::Simulation::TrackingAction::m_ignoreSecondaries
bool m_ignoreSecondaries
do not store secondaries in MCParticles
Definition: TrackingAction.h:128
Belle2::Simulation::TrackingAction::m_ignoreBremsstrahlungPhotons
bool m_ignoreBremsstrahlungPhotons
do not store bremsstrahlung photons in MCParticles
Definition: TrackingAction.h:130
Belle2::Simulation::TrackingAction::m_bremsstrahlungPhotonsEnergyCut
double m_bremsstrahlungPhotonsEnergyCut
kinetic energy cut for stored bremsstrahlung photons [MeV]
Definition: TrackingAction.h:131
Belle2::Simulation::TrackingAction::m_secondariesEnergyCut
double m_secondariesEnergyCut
kinetic energy cut for stored secondaries [MeV]
Definition: TrackingAction.h:129
Belle2::Simulation::TrackingAction::m_relMCTrajectories
RelationArray m_relMCTrajectories
RelationArry for the relation between MCParticles and Trajectories.
Definition: TrackingAction.h:142
Belle2::Simulation::TrackingAction::m_pairConversionsEnergyCut
double m_pairConversionsEnergyCut
kinetic energy cut for stored e+ or e- from pair conversions [MeV]
Definition: TrackingAction.h:133
Belle2::Simulation::TrackingAction::m_distanceTolerance
double m_distanceTolerance
distance tolerance to merge trajectory points
Definition: TrackingAction.h:137
Belle2::Simulation::TrackingAction::m_mcParticleGraph
MCParticleGraph & m_mcParticleGraph
< Reference to the MCParticle graph which is updated by the tracking action.
Definition: TrackingAction.h:125
Belle2::Simulation::TrackingAction::m_ignorePairConversions
bool m_ignorePairConversions
do not store e+ or e- from pair conversions in MCparticles
Definition: TrackingAction.h:132
Belle2::Simulation::TrackingAction::m_ignoreOpticalPhotons
bool m_ignoreOpticalPhotons
do not store optical photons in MCParticles
Definition: TrackingAction.h:127
Belle2::StoreArray< MCParticle >
Belle2::Simulation::TrackingAction::m_storeTrajectories
int m_storeTrajectories
Store trajectories for 0=none, 1=primary or 2=all particles.
Definition: TrackingAction.h:136