Class to keep track of the traversal of the sensitive volume for one track. More...

#include <SensorTraversal.h>

Public Member Functions
void	add (const G4ThreeVector &position, double depEnergy, double visibleEnergy, double length)
	add a new step

int	getTrackID () const
	get Geant4 trackID

int	getLadderID () const
	get the ladder ID

int	getSensorID () const
	get the sensor ID

int	getPDGCode () const
	get PDG code of the particle

double	getDepEnergy () const
	get total energy deposition

double	getVisibleEnergy () const
	get visible energy deposition

double	getLength () const
	get flight length so far

double	getEntryTime () const
	get entry time

const G4ThreeVector &	getEntryMomentum () const
	get entry momentum

const G4ThreeVector &	getEntryPosition () const
	get entry position

const G4ThreeVector &	getExitPosition () const
	get exit position

bool	isContained () const
	return whether the track was contained in the volume so far

bool	isPrimary () const
	return whether the track belongs to a primary particle

void	hasEntered ()
	indicate that the track originated outside the current volume

void	hasLeft ()
	indicate that the track left the current volume

void	setInitial (int trackID, int ladderID, int sensorID, int pdgCode, bool primary, const G4ThreeVector &position, const G4ThreeVector &momentum, double time)
	set initial values for a new track

void	reset ()
	reset to be used again

bool	check (int trackID, int ladderID, int sensorID)
	check if a track belongs to this object

Private Attributes
G4ThreeVector	m_entryMomentum
	Entry Position.

G4ThreeVector	m_entryPosition
	Entry Position.

G4ThreeVector	m_exitPosition
	Exit Position.

int	m_trackID {0}
	Geant4 Track ID.

int	m_ladderID {0}
	Ladder ID.

int	m_sensorID {0}
	Sensor ID.

int	m_pdgCode {0}
	PDG code for the particle.

double	m_depEnergy {0}
	Total deposited energy by this track.

double	m_visibleEnergy {0}
	Total visible energy by this track.

double	m_length {0}
	length of the sensor traversal

double	m_entryTime {0}
	time the track entered the volume

bool	m_contained {true}
	Indication whether the track is completely contained inside the volume.

bool	m_primary {false}
	Indication whether track is from a primary particle.

Detailed Description

Class to keep track of the traversal of the sensitive volume for one track.

This class keeps the necessary information to create consolidated SimHit objects after a particle finishes its traversal of the sensitive detector

Definition at line 25 of file SensorTraversal.h.

Member Function Documentation

◆ add()

void add	(	const G4ThreeVector &	position,
		double	depEnergy,
		double	visibleEnergy,
		double	length )

inline

add a new step

Parameters

position	position of the step
depEnergy	energy deposition
visibleEnergy	visible energy deposition
length	flight length so far

Definition at line 33 of file SensorTraversal.h.

      {
        m_depEnergy += depEnergy;
        m_visibleEnergy += visibleEnergy;
        m_length += length;
        m_exitPosition = position;
      }

◆ check()

bool check	(	int	trackID,
		int	ladderID,
		int	sensorID )

inline

check if a track belongs to this object

Definition at line 104 of file SensorTraversal.h.

      {
        // object not set yet so we can use it
        if (m_trackID == 0) return true;
        return (trackID == m_trackID && ladderID == m_ladderID && sensorID == m_sensorID);
      }

◆ getDepEnergy()

double getDepEnergy ( ) const

inline

get total energy deposition

Definition at line 50 of file SensorTraversal.h.

50{ return m_depEnergy; }

◆ getEntryMomentum()

const G4ThreeVector & getEntryMomentum ( ) const

inline

get entry momentum

Definition at line 58 of file SensorTraversal.h.

58{ return m_entryMomentum; }

◆ getEntryPosition()

const G4ThreeVector & getEntryPosition ( ) const

inline

get entry position

Definition at line 60 of file SensorTraversal.h.

60{ return m_entryPosition; }

◆ getEntryTime()

double getEntryTime ( ) const

inline

get entry time

Definition at line 56 of file SensorTraversal.h.

56{ return m_entryTime; }

◆ getExitPosition()

const G4ThreeVector & getExitPosition ( ) const

inline

get exit position

Definition at line 62 of file SensorTraversal.h.

62{ return m_exitPosition; }

◆ getLadderID()

int getLadderID ( ) const

inline

get the ladder ID

Definition at line 44 of file SensorTraversal.h.

44{ return m_ladderID; }

◆ getLength()

double getLength ( ) const

inline

get flight length so far

Definition at line 54 of file SensorTraversal.h.

54{ return m_length; }

◆ getPDGCode()

int getPDGCode ( ) const

inline

get PDG code of the particle

Definition at line 48 of file SensorTraversal.h.

48{ return m_pdgCode; }

◆ getSensorID()

int getSensorID ( ) const

inline

get the sensor ID

Definition at line 46 of file SensorTraversal.h.

46{ return m_sensorID; }

◆ getTrackID()

int getTrackID ( ) const

inline

get Geant4 trackID

Definition at line 42 of file SensorTraversal.h.

42{ return m_trackID; }

◆ getVisibleEnergy()

double getVisibleEnergy ( ) const

inline

get visible energy deposition

Definition at line 52 of file SensorTraversal.h.

52{ return m_visibleEnergy; }

◆ hasEntered()

void hasEntered ( )

inline

indicate that the track originated outside the current volume

Definition at line 70 of file SensorTraversal.h.

70{ m_contained = false; }

◆ hasLeft()

void hasLeft ( )

inline

indicate that the track left the current volume

Definition at line 72 of file SensorTraversal.h.

72{ m_contained = false; }

◆ isContained()

bool isContained ( ) const

inline

return whether the track was contained in the volume so far

Definition at line 65 of file SensorTraversal.h.

65{ return m_contained; }

◆ isPrimary()

bool isPrimary ( ) const

inline

return whether the track belongs to a primary particle

Definition at line 67 of file SensorTraversal.h.

67{ return m_primary; }

◆ reset()

void reset ( )

inline

reset to be used again

Definition at line 89 of file SensorTraversal.h.

      {
        m_trackID = 0;
        m_ladderID = 0;
        m_sensorID = 0;
        m_pdgCode = 0;
        m_depEnergy = 0;
        m_visibleEnergy = 0;
        m_length = 0;
        m_contained = true;
        m_primary = false;
        m_entryTime = 0;
      }

◆ setInitial()

void setInitial	(	int	trackID,
		int	ladderID,
		int	sensorID,
		int	pdgCode,
		bool	primary,
		const G4ThreeVector &	position,
		const G4ThreeVector &	momentum,
		double	time )

inline

set initial values for a new track

Definition at line 75 of file SensorTraversal.h.

      {
        m_trackID = trackID;
        m_ladderID = ladderID;
        m_sensorID = sensorID;
        m_pdgCode = pdgCode;
        m_primary = primary;
        m_entryPosition = position;
        m_entryMomentum = momentum;
        m_entryTime = time;
      }

Member Data Documentation

◆ m_contained

bool m_contained {true}

private

Indication whether the track is completely contained inside the volume.

Definition at line 135 of file SensorTraversal.h.

135{true};

◆ m_depEnergy

double m_depEnergy {0}

private

Total deposited energy by this track.

Definition at line 127 of file SensorTraversal.h.

127{0};

◆ m_entryMomentum

G4ThreeVector m_entryMomentum

private

Entry Position.

Definition at line 113 of file SensorTraversal.h.

◆ m_entryPosition

G4ThreeVector m_entryPosition

private

Entry Position.

Definition at line 115 of file SensorTraversal.h.

◆ m_entryTime

double m_entryTime {0}

private

time the track entered the volume

Definition at line 133 of file SensorTraversal.h.

133{0};

◆ m_exitPosition

G4ThreeVector m_exitPosition

private

Exit Position.

Definition at line 117 of file SensorTraversal.h.

◆ m_ladderID

int m_ladderID {0}

private

Ladder ID.

Definition at line 121 of file SensorTraversal.h.

121{0};

◆ m_length

double m_length {0}

private

length of the sensor traversal

Definition at line 131 of file SensorTraversal.h.

131{0};

◆ m_pdgCode

int m_pdgCode {0}

private

PDG code for the particle.

Definition at line 125 of file SensorTraversal.h.

125{0};

◆ m_primary

bool m_primary {false}

private

Indication whether track is from a primary particle.

Definition at line 137 of file SensorTraversal.h.

137{false};

◆ m_sensorID

int m_sensorID {0}

private

Sensor ID.

Definition at line 123 of file SensorTraversal.h.

123{0};

◆ m_trackID

int m_trackID {0}

private

Geant4 Track ID.

Definition at line 119 of file SensorTraversal.h.

119{0};

◆ m_visibleEnergy

double m_visibleEnergy {0}

private

Total visible energy by this track.

Definition at line 129 of file SensorTraversal.h.

129{0};

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

beast/claws/simulation/include/SensorTraversal.h

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ add()

◆ check()

◆ getDepEnergy()

◆ getEntryMomentum()

◆ getEntryPosition()

◆ getEntryTime()

◆ getExitPosition()

◆ getLadderID()

◆ getLength()

◆ getPDGCode()

◆ getSensorID()

◆ getTrackID()

◆ getVisibleEnergy()

◆ hasEntered()

◆ hasLeft()

◆ isContained()

◆ isPrimary()

◆ reset()

◆ setInitial()

Member Data Documentation

◆ m_contained

◆ m_depEnergy

◆ m_entryMomentum

◆ m_entryPosition

◆ m_entryTime

◆ m_exitPosition

◆ m_ladderID

◆ m_length

◆ m_pdgCode

◆ m_primary

◆ m_sensorID

◆ m_trackID

◆ m_visibleEnergy