REST-for-Physics  v2.3
Rare Event Searches ToolKit for Physics
Public Member Functions | Private Member Functions | Private Attributes
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.

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.

// It will register the number of neutron tracks per event
<observable name="totalEdep" value="ON"
description="Total event energy registered in keV" />

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.

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

<observable name="xOriginPrimary" value="ON"
description="x-coordinate of the primary event." />

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.

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

<observable name="bremstralung" value="ON"
description="Its value will be 1 if the event contains a bremstralung
physics process." />

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. More...
 
TRestEventProcessMaker ()
 Returns a new instance of this class.
 
void PrintMetadata () override
 It prints out the process parameters stored in the metadata structure.
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 The main processing event function.
 
 TRestGeant4AnalysisProcess ()
 Default constructor.
 
 TRestGeant4AnalysisProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestGeant4AnalysisProcess ()
 Default destructor.
 
- Public Member Functions inherited from TRestEventProcess
virtual Bool_t AddInputFile (const std::string &file)
 
bool ApplyCut ()
 
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()
 
TRestAnalysisTreeGetAnalysisTree () const
 Return the local analysis tree (dummy)
 
TCanvas * GetCanvas () const
 Get canvas.
 
TRestAnalysisTreeGetFullAnalysisTree ()
 
std::vector< std::string > GetListOfAddedObservables ()
 
TRestRunGetRunInfo () 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
 This method does some preparation of xml section. More...
 
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)
 
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.
 
TRestGeant4MetadatafG4Metadata
 A pointer to the simulation metadata information accessible to TRestRun.
 
TRestGeant4EventfInputG4Event
 A pointer to the specific TRestGeant4Event input.
 
std::vector< std::string > fMeanPosObservables
 A std::vector storing the name of active volumes. More...
 
TRestGeant4EventfOutputG4Event
 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 ()
 
TRestEventProcessGetFriend (const std::string &nameOrType)
 
TRestEventProcessGetFriendLive (const std::string &nameOrType)
 
template<class T >
T * GetMetadata ()
 Get a metadata object from the host TRestRun. More...
 
TRestMetadataGetMetadata (const std::string &nameOrType)
 
size_t GetNumberOfParallelProcesses () const
 
template<class T >
GetObservableValue (const std::string &name)
 
TRestEventProcessGetParallel (int i)
 
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. More...
 
template<class T >
void SetObservableValue (const std::string &name, const T &value)
 Set observable value for AnalysisTree. More...
 
- Protected Attributes inherited from TRestEventProcess
TRestAnalysisTreefAnalysisTree = 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. More...
 
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. More...
 
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
 
TRestRunfRunInfo = 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()

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 218 of file TRestGeant4AnalysisProcess.cxx.

Member Function Documentation

◆ 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 259 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.

◆ 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.


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