REST-for-Physics  v2.3
Rare Event Searches ToolKit for Physics
Loading...
Searching...
No Matches
TRestGeant4AnalysisProcess Class Reference

Detailed Description

A pure analysis process to extract information from a TRestGeant4Event.

The TRestGeant4AnalysisProcess allows to extract valuable information from a TRestGeant4Event which contains the information of energy deposits from a Geant4 MonteCarlo simulation. TRestGeant4Event stores hits which include the physical process and geometry volume id where the interaction took place. This process accesses the Geant4 event data and metadata information and it will add the observables defined by the user to the analysisTree.

Observables

This process includes generic observables by using a common pattern inside the observable name. These observables require to be completed with the name of a volume used in the GDML geometry, or the name of a particle following Geant4 conventions.

The following list describes the generic observables that can be used in this analysis process.

  • VolumeEDep: This observable will register the total energy deposited in a particular volume of the geometry. We must specify the volume name before the keyword volumeEDep.
  • MeanPos: This observable will register the mean position of the hits that have been registered in a particular volume of the geometry. We must specify the volume name before the keyword MeanPos, and after the keyword the axis we want to register.
  • TracksCounter: This observable will register the number of tracks of a given Geant4 particle found at each event. The keyword TracksCounter must be preceded by the name of the particle.
  • TracksEDep: This observable will register the total energy deposited by a given particle. The keyword TracksEDep must be preceded by the name of the particle.
Warning
It is important to notice that the keyword used for these observables is case sensitive!

In addition to these generic observables we have also an observable to measure the total energy deposited in all volumes.

The following list provides observables that can be defined in order to add to the TRestAnalysisTree information related to the primary event, as the position, direction or energy of the the primary generated.

  • xOriginPrimary: x-coordinate defining where the primary event was generated.
  • yOriginPrimary: y-coordinate defining where the primary event was generated.
  • zOriginPrimary: z-coordinate defining where the primary event was generated.
  • xDirectionPrimary: x-component defining the momentum direction of the primary event generated.
  • yDirectionPrimary: y-component defining the momentum direction of the primary event generated.
  • zDirectionPrimary: z-component defining the momentum direction of the primary event generated.
  • thetaPrimary: polar angle of the primary generated particle.
  • phiPrimary: azimuth angle of the primary generated particle.
  • energyPrimary: energy of the primary event generated.
  • boundingSize: It stores a value with the event size calculated as the diagonal distance of a bounding box defined to contain all the hits that produced an energy deposit.

The following code ilustrates the addition of a primary event observable.

There are also observables allowing to identify the events where certain physical processes took place. This will allow, for example, to select event populations where particular physics processes happened, or to determine the probability of a certain physics process to occur in our simulation.

The following list defines the physics processes observables that can be defined in this analysis process. These observables only register if the process happened or not, by associating them a value, 1 or 0.

  • photoelectric: It is 1 if a gamma was absorbed by a photoelectric process, 0 otherwise.
  • compton: It is 1 if a gamma was scattered by a compton scattering process, 0 otherwise.
  • bremstralung: It is 1 if gamma radiation was produced by a bremstralung process, 0 otherwise.
  • hadElastic: It is 1 if hadron elastic scattering took place in that event, 0 otherwise.
  • neutronInelastic: It is 1 if neutron inelastic scattering took place inside the event, 0 otherwise.
  • nCapture: It is 1 if a neutron capture process happened, 0 otherwise.
  • hIoni: It is 1 if a hadron ionization process took place in the event, 0 otherwise.

The following code ilustrates the addition of a physics process observable.


RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2016-March: First implementation of Geant4 analysis process into REST_v2. Javier Galan

2017-October: Generic upgrades to add particle and volume observables. Gloria Luzon and Javier Galan

Author
Javier Galan
Gloria Luzon

Definition at line 32 of file TRestGeant4AnalysisProcess.h.

#include <TRestGeant4AnalysisProcess.h>

Inheritance diagram for TRestGeant4AnalysisProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestGeant4AnalysisProcess, 3)
void EndProcess () override
 Function to include required actions after all events have been processed.
RESTValue GetInputEvent () const override
 Get pointer to input event. Must be implemented in the derived class.
RESTValue GetOutputEvent () const override
 Get pointer to output event. Must be implemented in the derived class.
const char * GetProcessName () const override
 Returns the name of this process.
void InitProcess () override
 Process initialization. Observable names are interpreted and auxiliar observable members, related to VolumeEdep, MeanPos, TracksCounter, TrackEDep observables defined in TRestGeant4AnalysisProcess are filled at this stage.
void LoadConfig (const std::string &configFilename, const std::string &name="")
 Function to load the configuration from an external configuration file.
TRestEventProcess * Maker ()
 Returns a new instance of this class.
void PrintMetadata () override
 It prints out the process parameters stored in the metadata structure.
TRestEvent * ProcessEvent (TRestEvent *inputEvent) override
 The main processing event function.
 TRestGeant4AnalysisProcess ()
 Default constructor.
 TRestGeant4AnalysisProcess (const char *configFilename)
 Constructor loading data from a config file.
 ~TRestGeant4AnalysisProcess ()
 Default destructor.
Public Member Functions inherited from TRestEventProcess
virtual Bool_t AddInputFile (const std::string &file)
bool ApplyCut ()
 Apply cut according to the cut conditions saved in fCut.
virtual void BeginOfEventProcess (TRestEvent *inputEvent=nullptr)
 Begin of event process, preparation work. Called right before ProcessEvent().
 ClassDefOverride (TRestEventProcess, 3)
virtual void EndOfEventProcess (TRestEvent *inputEvent=nullptr)
 End of event process. Nothing to do. Called directly after ProcessEvent().
TRestAnalysisTree * GetAnalysisTree () const
 Return the local analysis tree (dummy).
TCanvas * GetCanvas () const
 Get canvas.
TRestAnalysisTree * GetFullAnalysisTree ()
 Get the full analysis tree from TRestRun, with non-empty entries.
std::vector< std::string > GetListOfAddedObservables ()
 Get list of observables, convert map to vector.
TRestRun * GetRunInfo () const
 Return the pointer of the hosting TRestRun object.
virtual Long64_t GetTotalBytes () const
virtual Long64_t GetTotalBytesRead () const
 Interface to external file reading, get the read bytes. To be implemented in external processes.
virtual void InitFromConfigFile () override
 To make settings from rml file. This method must be implemented in the derived class.
Bool_t isExternal () const
 Return whether this process is external process.
Int_t LoadSectionMetadata () override
 Load extra section metadata: outputlevel after calling TRestMetadata::LoadSectionMetadata().
virtual void NotifyAnalysisTreeReset ()
 In case the analysis tree is reset(switched to new file), some process needs to have action.
virtual Bool_t OpenInputFiles (const std::vector< std::string > &files)
 Interface to external file reading, open input file. To be implemented in external processes.
std::vector< std::string > ReadObservables ()
void RegisterAllObservables (Bool_t value=true)
virtual Bool_t ResetEntry ()
void SetAnalysisTree (TRestAnalysisTree *tree)
 Set analysis tree of this process, then add observables to it.
void SetCanvasSize (Int_t x, Int_t y)
 Set canvas size.
void SetFriendProcess (TRestEventProcess *p)
 Add friendly process to this process.
void SetObservableValidation (bool validate)
void SetParallelProcess (TRestEventProcess *p)
 Add parallel process to this process.
void SetRunInfo (TRestRun *r)
 Set TRestRun for this process.
Bool_t singleThreadOnly () const
 Return whether this process is single std::thread only.
 TRestEventProcess ()
 ~TRestEventProcess ()

Private Member Functions

void Initialize () override
 Function to initialize input/output event members and define the section name.
void LoadDefaultConfig ()
 Function to load the default config in absence of RML input.

Private Attributes

std::vector< std::string > fDirID
std::vector< std::string > fEnergyInObservables
 It stores the name of observables xxxVolumeEDep related to the energy deposition in volume xxx.
TRestGeant4Metadata * fG4Metadata
 A pointer to the simulation metadata information accessible to TRestRun.
TRestGeant4Event * fInputG4Event
 A pointer to the specific TRestGeant4Event input.
std::vector< std::string > fMeanPosObservables
 A std::vector storing the name of active volumes.
TRestGeant4Event * fOutputG4Event
 A pointer to the specific TRestGeant4Event output.
std::vector< std::string > fParticleTrackCounter
 A std::vector storing the xxx particle name extracted from xxxTracksCounter.
std::vector< std::string > fParticleTrackEdep
 A std::vector storing the xxx particle name extracted from xxxTracksEDep.
Bool_t fPerProcessSensitiveEnergy = false
Bool_t fPerProcessSensitiveEnergyNorm = false
std::vector< std::string > fProcessName
 A std::vector storing the name of processes.
std::vector< std::string > fProcessObservables
 A std::vector storing the name of observables related to processes in a particular active volume.
std::vector< std::string > fTrackCounterObservables
 A std::vector storing the observable name xxxTracksCounter for a given xxx particle.
std::vector< std::string > fTracksEDepObservables
 A std::vector storing the observable name xxxTracksEDep for a given xxx particle.
std::vector< Int_t > fVolumeID
 A std::vector storing the active volume ids of observables xxxVolumeEDep.
std::vector< Int_t > fVolumeID2
 A std::vector storing the active volume ids corresponding mean position observable xxxMeanPosX,Y,Z.
std::vector< Int_t > fVolumeID3
 A std::vector storing the active volume ids corresponding process observable .
std::vector< std::string > fVolumeName

Additional Inherited Members

Protected Types inherited from TRestEventProcess
enum  REST_Process_Output { No_Output , Observable , Internal_Var , Full_Output }
Protected Member Functions inherited from TRestEventProcess
void BeginPrintProcess ()
 [name, cut range]
void CreateCanvas ()
 Create the canvas.
void EndPrintProcess ()
 Pre-defined printer, can be used at the ending in the implementation of PrintMetadata().
TRestEventProcess * GetFriend (const std::string &nameOrType)
 Get friendly TRestEventProcess object.
TRestEventProcess * GetFriendLive (const std::string &nameOrType)
 Get friendly TRestEventProcess object.
template<class T>
T * GetMetadata ()
 Get a metadata object from the host TRestRun.
TRestMetadata * GetMetadata (const std::string &nameOrType)
 Get a metadata object from the host TRestRun.
size_t GetNumberOfParallelProcesses () const
template<class T>
T GetObservableValue (const std::string &name)
TRestEventProcess * GetParallel (int i)
 Get a list of parallel processes from this process.
template<class T>
std::vector< T > GetParallelDataMembers (T *member_of_process)
 Get a list of data members from parallel processes which is same to this process's certain data member.
template<class T>
void SetObservableValue (const std::string &name, const T &value)
 Set observable value for AnalysisTree.
Protected Attributes inherited from TRestEventProcess
TRestAnalysisTree * fAnalysisTree = nullptr
TCanvas * fCanvas = nullptr
 < Canvas for some viewer event
TVector2 fCanvasSize
 Canvas size.
std::vector< std::pair< std::string, TVector2 > > fCuts
 Stores cut definitions. Any listed observables should be in the range.
bool fDynamicObs = false
 It defines whether to use added observables only or all the observables appear in the code.
bool fIsExternal = false
 It defines if the process reads event data from an external source.
std::map< std::string, int > fObservablesDefined
 Stores the list of all the appeared process observables in the code.
std::map< std::string, int > fObservablesUpdated
 Stores the list of process observables updated when processing this event.
bool fReadOnly = false
 not used, keep for compatibility
TRestRun * fRunInfo = nullptr
 < Pointer to TRestRun object where to find metadata.
bool fSingleThreadOnly = false
bool fValidateObservables = false
 It defines if observable names should be added to the validation list.

Constructor & Destructor Documentation

◆ TRestGeant4AnalysisProcess() [1/2]

TRestGeant4AnalysisProcess::TRestGeant4AnalysisProcess ( )

Default constructor.

Definition at line 202 of file TRestGeant4AnalysisProcess.cxx.

◆ TRestGeant4AnalysisProcess() [2/2]

TRestGeant4AnalysisProcess::TRestGeant4AnalysisProcess ( const char * configFilename)

Constructor loading data from a config file.

If no configuration path is defined using TRestMetadata::SetConfigFilePath the path to the config file must be specified using full path, absolute or relative.

The default behaviour is that the config file must be specified with full path, absolute or relative.

Parameters
configFilenameA const char* giving the path to an RML file.

Definition at line 216 of file TRestGeant4AnalysisProcess.cxx.

◆ ~TRestGeant4AnalysisProcess()

TRestGeant4AnalysisProcess::~TRestGeant4AnalysisProcess ( )

Default destructor.

Definition at line 225 of file TRestGeant4AnalysisProcess.cxx.

Member Function Documentation

◆ EndProcess()

void TRestGeant4AnalysisProcess::EndProcess ( )
overridevirtual

Function to include required actions after all events have been processed.

Reimplemented from TRestEventProcess.

Definition at line 524 of file TRestGeant4AnalysisProcess.cxx.

◆ GetInputEvent()

RESTValue TRestGeant4AnalysisProcess::GetInputEvent ( ) const
inlineoverridevirtual

Get pointer to input event. Must be implemented in the derived class.

Implements TRestEventProcess.

Definition at line 93 of file TRestGeant4AnalysisProcess.h.

◆ GetOutputEvent()

RESTValue TRestGeant4AnalysisProcess::GetOutputEvent ( ) const
inlineoverridevirtual

Get pointer to output event. Must be implemented in the derived class.

Implements TRestEventProcess.

Definition at line 94 of file TRestGeant4AnalysisProcess.h.

◆ GetProcessName()

const char * TRestGeant4AnalysisProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 113 of file TRestGeant4AnalysisProcess.h.

◆ Initialize()

void TRestGeant4AnalysisProcess::Initialize ( )
overrideprivatevirtual

Function to initialize input/output event members and define the section name.

Reimplemented from TRestMetadata.

Definition at line 236 of file TRestGeant4AnalysisProcess.cxx.

◆ InitProcess()

void TRestGeant4AnalysisProcess::InitProcess ( )
overridevirtual

Process initialization. Observable names are interpreted and auxiliar observable members, related to VolumeEdep, MeanPos, TracksCounter, TrackEDep observables defined in TRestGeant4AnalysisProcess are filled at this stage.

Reimplemented from TRestEventProcess.

Definition at line 266 of file TRestGeant4AnalysisProcess.cxx.

◆ LoadConfig()

void TRestGeant4AnalysisProcess::LoadConfig ( const std::string & configFilename,
const std::string & name = "" )

Function to load the configuration from an external configuration file.

If no configuration path is defined in TRestMetadata::SetConfigFilePath the path to the config file must be specified using full path, absolute or relative.

Parameters
configFilenameA const char* giving the path to an RML file.
nameThe name of the specific metadata. It will be used to find the corresponding TRestGeant4AnalysisProcess section inside the RML.

Definition at line 257 of file TRestGeant4AnalysisProcess.cxx.

◆ LoadDefaultConfig()

void TRestGeant4AnalysisProcess::LoadDefaultConfig ( )
private

Function to load the default config in absence of RML input.

Definition at line 230 of file TRestGeant4AnalysisProcess.cxx.

◆ Maker()

TRestEventProcess * TRestGeant4AnalysisProcess::Maker ( )
inline

Returns a new instance of this class.

Definition at line 110 of file TRestGeant4AnalysisProcess.h.

◆ PrintMetadata()

void TRestGeant4AnalysisProcess::PrintMetadata ( )
inlineoverridevirtual

It prints out the process parameters stored in the metadata structure.

Reimplemented from TRestMetadata.

Definition at line 103 of file TRestGeant4AnalysisProcess.h.

◆ ProcessEvent()

TRestEvent * TRestGeant4AnalysisProcess::ProcessEvent ( TRestEvent * inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 395 of file TRestGeant4AnalysisProcess.cxx.

Field Documentation

◆ fDirID

std::vector<std::string> TRestGeant4AnalysisProcess::fDirID
private

A std::vector storing the direction X,Y or Z from corresponding mean position observable xxxMeanPosX,Y,Z.

Definition at line 59 of file TRestGeant4AnalysisProcess.h.

◆ fEnergyInObservables

std::vector<std::string> TRestGeant4AnalysisProcess::fEnergyInObservables
private

It stores the name of observables xxxVolumeEDep related to the energy deposition in volume xxx.

Definition at line 44 of file TRestGeant4AnalysisProcess.h.

◆ fG4Metadata

TRestGeant4Metadata* TRestGeant4AnalysisProcess::fG4Metadata
private

A pointer to the simulation metadata information accessible to TRestRun.

Definition at line 41 of file TRestGeant4AnalysisProcess.h.

◆ fInputG4Event

TRestGeant4Event* TRestGeant4AnalysisProcess::fInputG4Event
private

A pointer to the specific TRestGeant4Event input.

Definition at line 35 of file TRestGeant4AnalysisProcess.h.

◆ fMeanPosObservables

std::vector<std::string> TRestGeant4AnalysisProcess::fMeanPosObservables
private

A std::vector storing the name of active volumes.

It stores the name of observables (xxxMeanPosX,Y,Z) related to mean hits position in volume xxx.

Definition at line 52 of file TRestGeant4AnalysisProcess.h.

◆ fOutputG4Event

TRestGeant4Event* TRestGeant4AnalysisProcess::fOutputG4Event
private

A pointer to the specific TRestGeant4Event output.

Definition at line 38 of file TRestGeant4AnalysisProcess.h.

◆ fParticleTrackCounter

std::vector<std::string> TRestGeant4AnalysisProcess::fParticleTrackCounter
private

A std::vector storing the xxx particle name extracted from xxxTracksCounter.

Definition at line 74 of file TRestGeant4AnalysisProcess.h.

◆ fParticleTrackEdep

std::vector<std::string> TRestGeant4AnalysisProcess::fParticleTrackEdep
private

A std::vector storing the xxx particle name extracted from xxxTracksEDep.

Definition at line 80 of file TRestGeant4AnalysisProcess.h.

◆ fPerProcessSensitiveEnergy

Bool_t TRestGeant4AnalysisProcess::fPerProcessSensitiveEnergy = false
private

Definition at line 82 of file TRestGeant4AnalysisProcess.h.

◆ fPerProcessSensitiveEnergyNorm

Bool_t TRestGeant4AnalysisProcess::fPerProcessSensitiveEnergyNorm = false
private

Definition at line 83 of file TRestGeant4AnalysisProcess.h.

◆ fProcessName

std::vector<std::string> TRestGeant4AnalysisProcess::fProcessName
private

A std::vector storing the name of processes.

Definition at line 68 of file TRestGeant4AnalysisProcess.h.

◆ fProcessObservables

std::vector<std::string> TRestGeant4AnalysisProcess::fProcessObservables
private

A std::vector storing the name of observables related to processes in a particular active volume.

Definition at line 62 of file TRestGeant4AnalysisProcess.h.

◆ fTrackCounterObservables

std::vector<std::string> TRestGeant4AnalysisProcess::fTrackCounterObservables
private

A std::vector storing the observable name xxxTracksCounter for a given xxx particle.

Definition at line 71 of file TRestGeant4AnalysisProcess.h.

◆ fTracksEDepObservables

std::vector<std::string> TRestGeant4AnalysisProcess::fTracksEDepObservables
private

A std::vector storing the observable name xxxTracksEDep for a given xxx particle.

Definition at line 77 of file TRestGeant4AnalysisProcess.h.

◆ fVolumeID

std::vector<Int_t> TRestGeant4AnalysisProcess::fVolumeID
private

A std::vector storing the active volume ids of observables xxxVolumeEDep.

Definition at line 47 of file TRestGeant4AnalysisProcess.h.

◆ fVolumeID2

std::vector<Int_t> TRestGeant4AnalysisProcess::fVolumeID2
private

A std::vector storing the active volume ids corresponding mean position observable xxxMeanPosX,Y,Z.

Definition at line 55 of file TRestGeant4AnalysisProcess.h.

◆ fVolumeID3

std::vector<Int_t> TRestGeant4AnalysisProcess::fVolumeID3
private

A std::vector storing the active volume ids corresponding process observable .

Definition at line 65 of file TRestGeant4AnalysisProcess.h.

◆ fVolumeName

std::vector<std::string> TRestGeant4AnalysisProcess::fVolumeName
private

Definition at line 49 of file TRestGeant4AnalysisProcess.h.


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