The Tracking Action class. More...

#include <TrackingAction.h>

Inheritance diagram for TrackingAction:

Collaboration diagram for TrackingAction:

[legend]

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
MCParticleGraph &	m_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< MCParticleTrajectory >	m_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 30 of file TrackingAction.h.

Constructor & Destructor Documentation

◆ TrackingAction()

TrackingAction ( MCParticleGraph & mcParticleGraph )

explicit

Constructor.

Parameters

mcParticleGraph Reference to the MCParticle graph which is used to add secondary particles.

Definition at line 27 of file TrackingAction.cc.

                                                               :
   G4UserTrackingAction(), m_mcParticleGraph(mcParticleGraph),
   m_ignoreOpticalPhotons(false),
   m_ignoreSecondaries(false), m_secondariesEnergyCut(0.0),
   m_ignoreBremsstrahlungPhotons(false), m_bremsstrahlungPhotonsEnergyCut(0.0),
   m_ignorePairConversions(false), m_pairConversionsEnergyCut(0.0),
   m_storeTrajectories(false), m_distanceTolerance(0),
   m_storeMCTrajectories(), m_relMCTrajectories(StoreArray<MCParticle>(), m_storeMCTrajectories)
 {
 }

Member Function Documentation

◆ PostUserTrackingAction()

void PostUserTrackingAction ( const G4Track * track )

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

Parameters

track Pointer to the Geant4 track which was transported through the geometry.

Definition at line 143 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

track Pointer to the Geant4 track which will be transported through the geometry.

Definition at line 58 of file TrackingAction.cc.

◆ setBremsstrahlungPhotonsEnergyCut()

void setBremsstrahlungPhotonsEnergyCut ( double cut_MeV )

inline

Set kinetic energy cut for bremsstrahlung photons.

Parameters

cut_MeV kinetic energy in MeV

Definition at line 92 of file TrackingAction.h.

92 {m_bremsstrahlungPhotonsEnergyCut = cut_MeV;}

◆ 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

ignore flag

Definition at line 86 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

ignore flag

Definition at line 65 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

ignore flag

Definition at line 100 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

ignore flag

Definition at line 72 of file TrackingAction.h.

◆ setPairConversionsEnergyCut()

void setPairConversionsEnergyCut ( double cut_MeV )

inline

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

Parameters

cut_MeV kinetic energy in MeV

Definition at line 106 of file TrackingAction.h.

◆ setSecondariesEnergyCut()

void setSecondariesEnergyCut ( double cut_MeV )

inline

Set kinetic energy cut for secondaries.

Parameters

cut_MeV kinetic energy in MeV

Definition at line 78 of file TrackingAction.h.

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

simulation/kernel/include/TrackingAction.h
simulation/kernel/src/TrackingAction.cc

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TrackingAction()

Member Function Documentation

◆ PostUserTrackingAction()

◆ PreUserTrackingAction()

◆ setBremsstrahlungPhotonsEnergyCut()

◆ setIgnoreBremsstrahlungPhotons()

◆ setIgnoreOpticalPhotons()

◆ setIgnorePairConversions()

◆ setIgnoreSecondaries()

◆ setPairConversionsEnergyCut()

◆ setSecondariesEnergyCut()