REST-for-Physics  v2.3
Rare Event Searches ToolKit for Physics
Public Member Functions | Protected Attributes
TRestGeant4Particle Class Reference

Detailed Description

A class used to store particle properties.

TRestGeant4Particle is just a container class to store particle properties


RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2015-July: First concept and implementation

Author
Javier Galan

Definition at line 32 of file TRestGeant4Particle.h.

#include <TRestGeant4Particle.h>

Inheritance diagram for TRestGeant4Particle:
TRestGeant4ParticleSource TRestGeant4ParticleSourceCosmics TRestGeant4ParticleSourceCry TRestGeant4ParticleSourceDecay0

Public Member Functions

Double_t GetEnergy () const
 
Double_t GetExcitationLevel () const
 
TVector3 GetMomentumDirection () const
 
TVector3 GetOrigin () const
 
Int_t GetParticleCharge () const
 
TString GetParticleName () const
 
void Print () const
 Prints on screen the details about the Geant4 simulation conditions, stored in TRestGeant4Metadata. More...
 
void SetDirection (const TVector3 &dir)
 
void SetEnergy (Double_t en)
 
void SetExcitationLevel (Double_t excitationEnergy)
 
void SetOrigin (const TVector3 &pos)
 
void SetParticle (TRestGeant4Particle particle)
 A copy method. More...
 
void SetParticleCharge (Int_t charge)
 
void SetParticleName (TString particle)
 

Protected Attributes

Int_t fCharge = 0
 
TVector3 fDirection = {1, 0, 0}
 
Double_t fEnergy = 0
 
Double_t fExcitationLevel = 0
 
TVector3 fOrigin
 
TString fParticleName
 

Constructor & Destructor Documentation

◆ TRestGeant4Particle()

TRestGeant4Particle::TRestGeant4Particle ( )

Definition at line 46 of file TRestGeant4Particle.cxx.

◆ ~TRestGeant4Particle()

TRestGeant4Particle::~TRestGeant4Particle ( )
virtual

Definition at line 50 of file TRestGeant4Particle.cxx.

Member Function Documentation

◆ GetEnergy()

Double_t TRestGeant4Particle::GetEnergy ( ) const
inline

Definition at line 44 of file TRestGeant4Particle.h.

◆ GetExcitationLevel()

Double_t TRestGeant4Particle::GetExcitationLevel ( ) const
inline

Definition at line 43 of file TRestGeant4Particle.h.

◆ GetMomentumDirection()

TVector3 TRestGeant4Particle::GetMomentumDirection ( ) const
inline

Definition at line 45 of file TRestGeant4Particle.h.

◆ GetOrigin()

TVector3 TRestGeant4Particle::GetOrigin ( ) const
inline

Definition at line 47 of file TRestGeant4Particle.h.

◆ GetParticleCharge()

Int_t TRestGeant4Particle::GetParticleCharge ( ) const
inline

Definition at line 46 of file TRestGeant4Particle.h.

◆ GetParticleName()

TString TRestGeant4Particle::GetParticleName ( ) const
inline

Definition at line 42 of file TRestGeant4Particle.h.

◆ Print()

void TRestGeant4Particle::Print ( ) const

Prints on screen the details about the Geant4 simulation conditions, stored in TRestGeant4Metadata.

Definition at line 69 of file TRestGeant4Particle.cxx.

◆ SetDirection()

void TRestGeant4Particle::SetDirection ( const TVector3 &  dir)
inline

Definition at line 60 of file TRestGeant4Particle.h.

◆ SetEnergy()

void TRestGeant4Particle::SetEnergy ( Double_t  en)
inline

Definition at line 61 of file TRestGeant4Particle.h.

◆ SetExcitationLevel()

void TRestGeant4Particle::SetExcitationLevel ( Double_t  excitationEnergy)
inline

Definition at line 53 of file TRestGeant4Particle.h.

◆ SetOrigin()

void TRestGeant4Particle::SetOrigin ( const TVector3 &  pos)
inline

Definition at line 62 of file TRestGeant4Particle.h.

◆ SetParticle()

void TRestGeant4Particle::SetParticle ( TRestGeant4Particle  particle)

A copy method.

Definition at line 57 of file TRestGeant4Particle.cxx.

◆ SetParticleCharge()

void TRestGeant4Particle::SetParticleCharge ( Int_t  charge)
inline

Definition at line 58 of file TRestGeant4Particle.h.

◆ SetParticleName()

void TRestGeant4Particle::SetParticleName ( TString  particle)
inline

Definition at line 51 of file TRestGeant4Particle.h.

Field Documentation

◆ fCharge

Int_t TRestGeant4Particle::fCharge = 0
protected

Definition at line 38 of file TRestGeant4Particle.h.

◆ fDirection

TVector3 TRestGeant4Particle::fDirection = {1, 0, 0}
protected

Definition at line 36 of file TRestGeant4Particle.h.

◆ fEnergy

Double_t TRestGeant4Particle::fEnergy = 0
protected

Definition at line 37 of file TRestGeant4Particle.h.

◆ fExcitationLevel

Double_t TRestGeant4Particle::fExcitationLevel = 0
protected

Definition at line 35 of file TRestGeant4Particle.h.

◆ fOrigin

TVector3 TRestGeant4Particle::fOrigin
protected

Definition at line 39 of file TRestGeant4Particle.h.

◆ fParticleName

TString TRestGeant4Particle::fParticleName
protected

Definition at line 34 of file TRestGeant4Particle.h.


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