allpix::TrackInfoG4
Allpix implementation of G4VUserTrackInformation to handle unique track IDs and the creation of MCTracks.
#include <TrackInfoG4.hpp>
Inherits from G4VUserTrackInformation
Public Functions
Name | |
---|---|
TrackInfoG4(int custom_track_id, int parent_track_id, const G4Track *const aTrack) Only available constructor. |
|
int | getID() const Getter for custom id of track. |
int | getParentID() const Getter for parent’s track id of track. |
void | finalizeInfo(const G4Track *const aTrack) Update track info from the G4Track. |
const ROOT::Math::XYZPoint & | getStartPoint() const Get the point where the track originated in global coordinates. |
const ROOT::Math::XYZPoint & | getEndPoint() const Get the point of where the track terminated in global coordinates. |
int | getParticleID() const Get PDG particle id for the particle. |
double | getStartTime() const Get the starting time of the particle. |
double | getEndTime() const Get the end time of the particle. |
int | getCreationProcessType() const Get the Geant4 internal ID of the process which created the particle. |
double | getKineticEnergyInitial() const Getter for the kinetic energy the particle had when the track was created. |
double | getTotalEnergyInitial() const Getter for the total energy (i.e. kinetic energy and dynamic mass) the particle had when the track was created. |
double | getKineticEnergyFinal() const Getter for the kinetic energy the particle had when the track terminated. |
double | getTotalEnergyFinal() const Getter for the total energy (i.e. kinetic energy and dynamic mass) the particle had when the track terminated. |
const std::string & | getOriginatingVolumeName() const Getter for the Geant4 name of the physical volume in which the track originated. |
const std::string & | getTerminatingVolumeName() const Getter for the Geant4 name of the physical volume in which the track ends. |
const std::string & | getCreationProcessName() const Getter for the name of the process which created this particle. |
Public Functions Documentation
function TrackInfoG4
TrackInfoG4(
int custom_track_id,
int parent_track_id,
const G4Track *const aTrack
)
Only available constructor.
Parameters:
- custom_track_id The custom id for this track
- parent_track_id The custom id of parent track
- aTrack The Geant4 track
function getID
inline int getID() const
Getter for custom id of track.
Return: The custom track id
function getParentID
inline int getParentID() const
Getter for parent’s track id of track.
Return: The parent’s custrom track id
function finalizeInfo
void finalizeInfo(
const G4Track *const aTrack
)
Update track info from the G4Track.
Parameters:
- aTrack A pointer to a G4Track instance which represents this track’s final state
function getStartPoint
inline const ROOT::Math::XYZPoint & getStartPoint() const
Get the point where the track originated in global coordinates.
Return: Track start point
function getEndPoint
inline const ROOT::Math::XYZPoint & getEndPoint() const
Get the point of where the track terminated in global coordinates.
Return: Track end point
function getParticleID
inline int getParticleID() const
Get PDG particle id for the particle.
Return: Particle id
function getStartTime
inline double getStartTime() const
Get the starting time of the particle.
Return: The time at the beginning of the track
function getEndTime
inline double getEndTime() const
Get the end time of the particle.
Return: The time at the end of the track
function getCreationProcessType
inline int getCreationProcessType() const
Get the Geant4 internal ID of the process which created the particle.
Return: The Geant4 process type, or “-1” if no such process exists
function getKineticEnergyInitial
inline double getKineticEnergyInitial() const
Getter for the kinetic energy the particle had when the track was created.
Return: The kinetic energy in MeV of the particle at the beginning of the track
function getTotalEnergyInitial
inline double getTotalEnergyInitial() const
Getter for the total energy (i.e. kinetic energy and dynamic mass) the particle had when the track was created.
Return: The total energy in MeV of the particle at the beginning of the track
function getKineticEnergyFinal
inline double getKineticEnergyFinal() const
Getter for the kinetic energy the particle had when the track terminated.
Return: The kinetic energy in MeV of the particle at the end of the track
function getTotalEnergyFinal
inline double getTotalEnergyFinal() const
Getter for the total energy (i.e. kinetic energy and dynamic mass) the particle had when the track terminated.
Return: The total energy in MeV of the particle at the end of the track
function getOriginatingVolumeName
inline const std::string & getOriginatingVolumeName() const
Getter for the Geant4 name of the physical volume in which the track originated.
Return: The name of the phyical volume
function getTerminatingVolumeName
inline const std::string & getTerminatingVolumeName() const
Getter for the Geant4 name of the physical volume in which the track ends.
Return: The name of the phyical volume
function getCreationProcessName
inline const std::string & getCreationProcessName() const
Getter for the name of the process which created this particle.
Return: The process name, or “none” if no such process exists
Updated on 2024-12-13 at 08:31:36 +0000