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.

All energies are given in keV, positions in mm and angles in radians unless stated otherwise.

Volume names and aliases

Observables related to a volume require the name of a volume as it is registered in TRestGeant4Metadata, i.e. the full path of the physical volume (e.g. shielding/vessel/gas). Since these names may be long or contain characters not allowed in a branch name, the volume can be given through the volume attribute, and the observable name will then be just an alias, which must still end in the corresponding keyword.

<observable name="gasVolumeEDep" value="ON" volume="shielding/vessel/gas"

description="Energy deposited in the gas volume in keV" />

Warning: The volume must be defined as an active volume in the TRestGeant4Metadata <storage> section of the simulation, otherwise the observable is not registered and a warning with the list of active volumes is printed.

Generic 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, a process or a particle following Geant4 conventions.

**<volume>VolumeEDep**: The total energy deposited in a particular volume of the geometry.
<observable name="gasVolumeEDep" value="ON" volume="shielding/vessel/gas"

description="Energy deposited in the gas volume in keV" />

<observable name="vesselVolumeEDep" value="ON" volume="shielding/vessel"

description="Energy deposited in the vessel volume in keV" />
**<volume>MeanPos<X|Y|Z>**: The mean position of the hits that have been registered in a particular volume of the geometry. The keyword MeanPos must be followed by the axis (X, Y or Z).
<observable name="gasMeanPosX" value="ON" volume="shielding/vessel/gas"

description="Mean hits position in the gas volume (X-axis)" />

<observable name="gasMeanPosY" value="ON" volume="shielding/vessel/gas"

description="Mean hits position in the gas volume (Y-axis)" />
**<volume><Process>Process**: The energy deposited (in keV) in a particular volume by a given physics process. <Process> is either a REST process name from the table below, or a Geant4 process name with its first letter capitalized (e.g. Compt, HadElastic, NCapture).
<observable name="gasComptonProcess" value="ON" volume="shielding/vessel/gas"

description="Energy deposited in the gas by Compton scattering in keV" />

<observable name="gasHadElasticProcess" value="ON" volume="shielding/vessel/gas"

description="Energy deposited in the gas by hadron elastic scattering in keV" />
**<particle>TracksCounter**: The number of tracks of a given Geant4 particle found at each event.
<observable name="neutronTracksCounter" value="ON"

description="Number of neutron tracks found in the event" />

<observable name="gammaTracksCounter" value="ON"

description="Number of gamma tracks found in the event" />
**<particle>TracksEDep**: The total energy deposited by the tracks of a given Geant4 particle (in all volumes).
<observable name="neutronTracksEDep" value="ON"

description="Energy deposited by neutron tracks in keV" />

<observable name="gammaTracksEDep" value="ON"

description="Energy deposited by gamma tracks in keV" />

Warning: It is important to notice that the keyword used for these observables is case sensitive!

Physics process observables

containsProcess<Process>: It is 1 if the event contains at least one hit produced by the given Geant4 process, in any volume, and 0 otherwise. <Process> follows the same naming rules as in <volume><Process>Process, e.g. containsProcessCompt, containsProcessHadElastic or containsProcessNCapture. containsProcessPhot and containsProcessCompt are always evaluated, any other is evaluated only if it is defined in the RML. If the process does not exist in the physics information stored in TRestGeant4Metadata, a warning is printed and the value will be 0.

Note: REST identifies processes by Geant4 process type and subtype, so processes sharing them (e.g. eIoni, hIoni, ionIoni and muIoni) cannot be distinguished by containsProcess<Process>. Energy based observables (<volume><Process>Process and PerProcess<Name>) use the process name and are not affected.

The following table lists the REST process names and their Geant4 equivalent.

REST name	Geant4 name	Description
Photoelectric	phot	Photoelectric absorption
Compton	compt	Compton scattering
Rayleigh	Rayl	Rayleigh scattering
Conversion	conv	Gamma conversion (pair production)
PhotonNuclear	photonNuclear	Photonuclear interaction
Bremsstrahlung	eBrem	Electron/positron bremsstrahlung
Annihilation	annihil	Positron annihilation
EIoni	eIoni	Electron/positron ionisation
HIoni	hIoni	Hadron ionisation
IonIoni	ionIoni	Ion ionisation
MuIoni	muIoni	Muon ionisation
Msc	msc	Multiple scattering
CoulombScat	CoulombScat	Single Coulomb scattering
HadElastic	hadElastic	Hadron elastic scattering
NeutronInelastic	neutronInelastic	Neutron inelastic scattering
ProtonInelastic	protonInelastic	Proton inelastic scattering
NCapture	nCapture	Neutron capture
RadioactiveDecay	RadioactiveDecay	Radioactive decay
Decay	Decay	Particle decay

The legacy names Bremstralung, NInelastic and RadiactiveDecay are also accepted. Any other Geant4 process registered in the simulation can be used with its first letter capitalized. An unknown process name produces a warning and the observable is not filled.

PerProcess<Name>: If the parameter perProcessSensitiveEnergy is set to true, the following observables with the energy deposited in the sensitive volume by a given process are added automatically: PerProcessPhotoelectric (phot), PerProcessCompton (compt), PerProcessElectronicIoni (eIoni), PerProcessAlphaIoni (ionIoni and alphaIoni of alpha particles), PerProcessIonIoni (ionIoni), PerProcessHadronicIoni (hIoni), PerProcessProtonIoni (hIoni of protons), PerProcessMsc (msc), PerProcessHadronElastic (hadElastic) and PerProcessNeutronElastic (hadElastic of neutrons). These categories may overlap. If perProcessSensitiveEnergyNorm is true they are normalized to the total energy deposited in the sensitive volume.

Sensitive volume observables

sensitiveVolumeEnergy: The energy deposited in the sensitive volume.
sensitiveVolumeFirstHitTime: The time of the first hit with an energy deposit in the sensitive volume (infinity if there is none).

The following observables describe the first track outside the sensitive volume which is the ancestor of the tracks depositing energy in the sensitive volume. They are only filled when such a track exists.

firstTrackInSensitiveOk: 1 if there is exactly one such ancestor track, 0 otherwise.
firstTrackInSensitiveParticle: Particle name of the track (string).
firstTrackInSensitiveParentParticle: Particle name of its parent track (string, empty if it is a primary).
firstTrackInSensitiveCreatorProcess: Process which created the track (string).
firstTrackInSensitiveEnergy: Initial kinetic energy of the track.
firstTrackInSensitivePositionX/Y/Z: Initial position of the track.
firstTrackInSensitiveVolumeName: Volume of the first hit of the track (string).

String observables must be declared with type="string".

Primary and global observables

The following list provides observables related to the primary event, as the position, direction or energy of the primary generated.

xOriginPrimary, yOriginPrimary, zOriginPrimary: coordinates where the primary event was generated.
xDirectionPrimary, yDirectionPrimary, zDirectionPrimary: components of the momentum direction of the primary event generated.
thetaPrimary: polar angle of the primary generated particle.
phiPrimary: azimuth angle of the primary generated particle.
zenithYDegrees: angle, in degrees, between the primary direction and the -Y axis (zenith angle when Y is the vertical axis).
zenithSourceDegrees: angle, in degrees, between the primary direction and the direction of the first particle source defined in TRestGeant4Metadata.
energyPrimary: energy of the primary event generated.
eventPrimaryParticleName: name of the primary particle (string).
subEventPrimaryParticleName: name of the particle which originated the sub-event, or generator for the main event (sub-event id 0) (string).
totalEdep: the total energy deposited in all volumes.
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.

RML example

<TRestGeant4AnalysisProcess name="g4Ana" value="ON" verboseLevel="warning">
   <parameter name="perProcessSensitiveEnergy" value="false" />
 
   <observable name="totalEdep" value="ON" description="Total energy deposited in keV" />
   <observable name="energyPrimary" value="ON" description="Primary energy in keV" />
   <observable name="eventPrimaryParticleName" type="string" value="ON"
           description="Name of the primary particle" />
 
   <observable name="gasVolumeEDep" value="ON" volume="shielding/vessel/gas"
           description="Energy deposited in the gas in keV" />
   <observable name="gasComptonProcess" value="ON" volume="shielding/vessel/gas"
           description="Energy deposited in the gas by Compton scattering in keV" />
   <observable name="gasHadElasticProcess" value="ON" volume="shielding/vessel/gas"
           description="Energy deposited in the gas by hadron elastic scattering in keV" />
 
   <observable name="gammaTracksCounter" value="ON" description="Number of gamma tracks" />
   <observable name="neutronTracksCounter" value="ON" description="Number of neutron tracks" />
   <observable name="neutronTracksEDep" value="ON"
           description="Energy deposited by neutron tracks in keV" />
 
   <observable name="containsProcessCompt" type="int" value="ON"
           description="1 if the event contains a Compton scattering" />
   <observable name="containsProcessHadElastic" type="int" value="ON"
           description="1 if the event contains a hadron elastic scattering" />
   <observable name="containsProcessNCapture" type="int" value="ON"
           description="1 if the event contains a neutron capture" />
</TRestGeant4AnalysisProcess>

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

2026-October: Implemented <volume><Process>Process, generic containsProcess<Process> and PerProcess<Name> observables, and updated documentation. Alvaro Ezquerro

Author: Javier Galan; Gloria Luzon

Definition at line 32 of file TRestGeant4AnalysisProcess.h.

#include <TRestGeant4AnalysisProcess.h>

Inheritance diagram for TRestGeant4AnalysisProcess:

Public Member Functions
	ClassDefOverride (TRestGeant4AnalysisProcess, 3)

void	EndProcess () override
	Function to include required actions after all events have been processed. More...

std::string	GetGeant4ProcessName (const std::string &name) const
	It returns the Geant4 process name corresponding to `name`. More...

RESTValue	GetInputEvent () const override
	Get pointer to input event. Must be implemented in the derived class. More...

RESTValue	GetOutputEvent () const override
	Get pointer to output event. Must be implemented in the derived class. More...

const char *	GetProcessName () const override
	Returns the name of this process. More...

void	InitProcess () override
	Process initialization. Observable names are interpreted and auxiliar observable members, related to VolumeEdep, MeanPos, TracksCounter, TrackEDep, `<volume><Process>Process`, containsProcess and PerProcess observables defined in TRestGeant4AnalysisProcess are filled at this stage. More...

void	LoadConfig (const std::string &configFilename, const std::string &name="")
	Function to load the configuration from an external configuration file. More...

TRestEventProcess *	Maker ()
	Returns a new instance of this class. More...

void	PrintMetadata () override
	It prints out the process parameters stored in the metadata structure. More...

TRestEvent *	ProcessEvent (TRestEvent *inputEvent) override
	The main processing event function. More...

	TRestGeant4AnalysisProcess ()
	Default constructor. More...

	TRestGeant4AnalysisProcess (const char *configFilename)
	Constructor loading data from a config file. More...

	~TRestGeant4AnalysisProcess ()
	Default destructor. More...

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() More...

	ClassDefOverride (TRestEventProcess, 3)

virtual void	EndOfEventProcess (TRestEvent *inputEvent=nullptr)
	End of event process. Nothing to do. Called directly after ProcessEvent() More...

virtual void	EndProcess ()
	To be executed at the end of the run (outside event loop) More...

TRestAnalysisTree *	GetAnalysisTree () const
	Return the local analysis tree (dummy) More...

TCanvas *	GetCanvas () const
	Get canvas. More...

TRestAnalysisTree *	GetFullAnalysisTree ()

virtual RESTValue	GetInputEvent () const =0
	Get pointer to input event. Must be implemented in the derived class. More...

std::vector< std::string >	GetListOfAddedObservables ()

virtual RESTValue	GetOutputEvent () const =0
	Get pointer to output event. Must be implemented in the derived class. More...

virtual const char *	GetProcessName () const =0

TRestRun *	GetRunInfo () const
	Return the pointer of the hosting TRestRun object. More...

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

virtual void	InitFromConfigFile () override
	To make settings from rml file. This method must be implemented in the derived class. More...

virtual void	InitProcess ()
	To be executed at the beginning of the run (outside event loop) More...

Bool_t	isExternal () const
	Return whether this process is external process. More...

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

virtual Bool_t	OpenInputFiles (const std::vector< std::string > &files)

virtual TRestEvent *	ProcessEvent (TRestEvent *inputEvent)=0
	Process one event. More...

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

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

Bool_t	singleThreadOnly () const
	Return whether this process is single std::thread only. More...

	TRestEventProcess ()

	~TRestEventProcess ()

Public Member Functions inherited from TRestMetadata
void	AddLog (std::string log="", bool print=true)
	Add logs to messageBuffer. More...

void	DoNotStore ()
	If this method is called the metadata information will not be stored in disk. More...

TVector2	Get2DVectorParameterWithUnits (std::string parName, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TVector3 defaultValue=TVector3(-1, -1, -1))

TString	GetCommit ()
	Returns the REST commit value stored in fCommit. More...

std::string	GetConfigBuffer ()
	Returns the config section of this class. More...

std::string	GetDataMemberValue (std::string memberName)
	Get the value of data member as string. More...

std::vector< std::string >	GetDataMemberValues (std::string memberName, Int_t precision=0)
	Get the value of datamember as a vector of strings. More...

TString	GetDataPath ()
	Returns a std::string with the path used for data storage. More...

Double_t	GetDblParameterWithUnits (std::string parName, Double_t defaultValue=PARAMETER_NOT_FOUND_DBL)
	Gets the value of the parameter name parName, after applying unit conversion. More...

Bool_t	GetError () const
	It returns true if an error was identified by a derived metadata class. More...

TString	GetErrorMessage ()
	Returns a std::string containing the error message. More...

TString	GetLibraryVersion ()
	Returns the REST libraty version stored in fLibraryVersion. More...

TString	GetMainDataPath ()
	Gets a std::string with the path used for data storage. More...

Int_t	GetNumberOfErrors () const

Int_t	GetNumberOfWarnings () const

std::string	GetParameter (std::string parName, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns corresponding REST Metadata parameter from multiple sources. More...

std::string	GetSectionName ()
	Returns the section name of this class, defined at the beginning of fSectionName. More...

TRestStringOutput::REST_Verbose_Level	GetVerboseLevel ()
	returns the verboselevel in type of REST_Verbose_Level enumerator More...

TString	GetVerboseLevelString ()
	returns the verbose level in type of TString More...

TString	GetVersion ()
	Returns the REST version stored in fVersion. More...

Int_t	GetVersionCode ()

UInt_t	GetVersionMajor () const

UInt_t	GetVersionMinor () const

UInt_t	GetVersionPatch () const

Bool_t	GetWarning () const
	It returns true if an error was identified by a derived metadata class. More...

TString	GetWarningMessage ()
	Returns a std::string containing the warning message. More...

virtual void	Initialize ()
	Making default settings. More...

TRestMetadata *	InstantiateChildMetadata (int index, std::string pattern="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `index` given by argument, which defines the element order to be retrieved, 0 for first element found, 1 for the second element found, etc. More...

TRestMetadata *	InstantiateChildMetadata (std::string pattern="", std::string name="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `name` given by argument. More...

Bool_t	isCleanState () const

Bool_t	isOfficialRelease () const

Int_t	LoadConfigFromBuffer ()
	Initialize data from a string element buffer. More...

Int_t	LoadConfigFromElement (TiXmlElement eSectional, TiXmlElement eGlobal, std::map< std::string, std::string > envs={})
	Main starter method. More...

Int_t	LoadConfigFromFile (const std::string &configFilename, const std::string &sectionName="")
	Give the file name, find out the corresponding section. Then call the main starter. More...

virtual void	Merge (const TRestMetadata &)

TRestMetadata &	operator= (const TRestMetadata &)

void	Print ()
	Implementing TObject::Print() method. More...

void	PrintConfigBuffer ()
	Print the config xml section stored in the class. More...

void	PrintMessageBuffer ()
	Print the buffered message. More...

virtual void	PrintMetadata ()
	Implemented it in the derived metadata class to print out specific metadata information. More...

void	PrintTimeStamp (Double_t timeStamp)
	Print the current time on local machine. More...

void	SetConfigFile (std::string configFilename)
	set config file path from external More...

void	SetError (std::string message="", bool print=true, int maxPrint=5)
	A metadata class may use this method to signal that something went wrong. More...

void	SetHostmgr (TRestManager *m)
	Set the host manager for this class. More...

void	SetSectionName (std::string sName)
	set the section name, clear the section content More...

void	SetVerboseLevel (TRestStringOutput::REST_Verbose_Level v)
	sets the verbose level More...

void	SetWarning (std::string message="", bool print=true, int maxPrint=5)
	A metadata class may use this method to signal that something went wrong. More...

void	Store ()
	If this method is called the metadata information will be stored in disk. More...

	TRestMetadata (const TRestMetadata &)

virtual void	UpdateMetadataMembers ()
	Method to allow implementation of specific metadata members updates at inherited classes. More...

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	overwriting the write() method with fStore considered More...

void	WriteConfigBuffer (std::string fName)
	Writes the config buffer to a file in append mode. More...

	~TRestMetadata ()
	TRestMetadata default destructor. More...

Static Public Member Functions
static const std::map< std::string, std::string > &	GetRestToGeant4ProcessNameMap ()
	It returns the map between the process names used in REST observables (`<volume><Process>Process`) and the process names used by Geant4. More...

Protected Member Functions
std::map< std::string, std::string >	GetAliasObservableNameToVolume ()

Protected Member Functions inherited from TRestEventProcess
void	BeginPrintProcess ()
	[name, cut range]

void	CreateCanvas ()
	Create the canvas. More...

void	EndPrintProcess ()

TRestEventProcess *	GetFriend (const std::string &nameOrType)

TRestEventProcess *	GetFriendLive (const std::string &nameOrType)

template<class T >
T *	GetMetadata ()
	Get a metadata object from the host TRestRun. More...

TRestMetadata *	GetMetadata (const std::string &nameOrType)

size_t	GetNumberOfParallelProcesses () const

template<class T >
T	GetObservableValue (const std::string &name)

TRestEventProcess *	GetParallel (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 Member Functions inherited from TRestMetadata
std::string	ElementToString (TiXmlElement *ele)
	Convert an TiXmlElement object to string. More...

TVector2	Get2DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector3 defaultValue=TVector3(-1, -1, -1))

Double_t	GetDblParameterWithUnits (std::string parName, TiXmlElement *e, Double_t defaultVal=PARAMETER_NOT_FOUND_DBL)

TiXmlElement *	GetElement (std::string eleDeclare, TiXmlElement *e=nullptr)
	Get an xml element from a given parent element, according to its declaration. More...

TiXmlElement *	GetElementFromFile (std::string configFilename, std::string NameOrDecalre="")
	Open an xml encoded file and find its element. More...

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName)
	Get an xml element from the default location, according to its declaration and its field "name". More...

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName, TiXmlElement *e)
	Get an xml element from a given parent element, according to its declaration and its field "name". More...

std::string	GetFieldValue (std::string fieldName, std::string definition, size_t fromPosition=0)
	Gets field value in an xml element string by parsing it as TiXmlElement. More...

std::string	GetFieldValue (std::string parName, TiXmlElement *e)
	Returns the field value of an xml element which has the specified name. More...

std::string	GetKEYDefinition (std::string keyName)
	Gets the first key definition for keyName found inside buffer starting at fromPosition. More...

std::string	GetKEYDefinition (std::string keyName, size_t &Position)

std::string	GetKEYDefinition (std::string keyName, size_t &Position, std::string buffer)

std::string	GetKEYDefinition (std::string keyName, std::string buffer)

std::string	GetKEYStructure (std::string keyName)
	Gets the first key structure for keyName found inside buffer after fromPosition. More...

std::string	GetKEYStructure (std::string keyName, size_t &Position)

std::string	GetKEYStructure (std::string keyName, size_t &Position, std::string buffer)

std::string	GetKEYStructure (std::string keyName, size_t &Position, TiXmlElement *ele)

std::string	GetKEYStructure (std::string keyName, std::string buffer)

TiXmlElement *	GetNextElement (TiXmlElement *e)
	Get the next sibling xml element of this element, with same eleDeclare. More...

std::string	GetParameter (std::string parName, size_t &pos, std::string inputString)
	Returns the value for the parameter name parName found in inputString. More...

std::string	GetParameter (std::string parName, TiXmlElement *e, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns the value for the parameter named parName in the given section. More...

std::pair< std::string, std::string >	GetParameterAndUnits (std::string parname, TiXmlElement *e=nullptr)
	Returns the unit string of the given parameter of the given xml section. More...

std::map< std::string, std::string >	GetParametersList ()
	It retrieves a map of all parameter:value found in the metadata class. More...

TString	GetSearchPath ()

virtual void	InitFromConfigFile ()
	To make settings from rml file. This method must be implemented in the derived class. More...

virtual void	InitFromRootFile ()
	Method called after the object is retrieved from root file. More...

virtual Int_t	LoadSectionMetadata ()
	This method does some preparation of xml section. More...

void	ReadAllParameters ()
	Reflection methods, Set value of a datamember in class according to TRestMetadata::fElement. More...

void	ReadParametersList (std::map< std::string, std::string > &list)
	It reads a parameter list and associates it to its corresponding metadata member. par0 --> fPar0. More...

std::string	ReplaceConstants (const std::string buffer)
	Identifies "constants" in the input buffer, and replace them with corresponding value. More...

std::string	ReplaceVariables (const std::string buffer)
	Identifies environmental variable replacing marks in the input buffer, and replace them with corresponding value. More...

void	ReSetVersion ()
	Resets the version of TRestRun to REST_RELEASE. Only TRestRun is allowed to update version. More...

std::string	SearchFile (std::string filename)
	Search files in current directory and directories specified in "searchPath" section. More...

void	SetLibraryVersion (TString version)
	Set the library version of this metadata class. More...

TiXmlElement *	StringToElement (std::string definition)
	Parsing a string into TiXmlElement object. More...

	TRestMetadata ()
	TRestMetadata default constructor. More...

	TRestMetadata (const char *configFilename)
	constructor More...

void	UnSetVersion ()
	Resets the version of TRestRun to -1, in case the file is old REST file. Only TRestRun is allowed to update version. More...

Private Member Functions
void	Initialize () override
	Function to initialize input/output event members and define the section name. More...

void	LoadDefaultConfig ()
	Function to load the default config in absence of RML input. More...

void	PrintNotActiveVolumeWarning (const TString &volumeName)
	It prints a warning when the volume used by an observable is not an active volume. More...

Private Attributes
std::vector< std::string >	fContainsProcessG4Name
	A std::vector storing the Geant4 process name corresponding to each `containsProcessXxx` observable. More...

std::vector< std::string >	fContainsProcessObservables
	A std::vector storing the observable names `containsProcessXxx`. More...

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`. More...

TRestGeant4Metadata *	fG4Metadata
	A pointer to the simulation metadata information accessible to TRestRun. More...

TRestGeant4Event *	fInputG4Event
	A pointer to the specific TRestGeant4Event input. More...

std::vector< std::string >	fMeanPosObservables
	A std::vector storing the name of active volumes. More...

TRestGeant4Event *	fOutputG4Event
	A pointer to the specific TRestGeant4Event output. More...

std::vector< std::string >	fParticleTrackCounter
	A std::vector storing the `xxx` particle name extracted from `xxxTracksCounter`. More...

std::vector< std::string >	fParticleTrackEdep
	A std::vector storing the `xxx` particle name extracted from `xxxTracksEDep`. More...

std::vector< std::vector< std::string > >	fPerProcessG4Names
	The Geant4 process names contributing to each `PerProcessXxx` observable. More...

std::vector< std::string >	fPerProcessObservables
	A std::vector storing the observable names `PerProcessXxx` (only if fPerProcessSensitiveEnergy). More...

std::vector< std::string >	fPerProcessParticle
	The particle restriction of each `PerProcessXxx` observable (empty means any particle). More...

Bool_t	fPerProcessSensitiveEnergy = false

Bool_t	fPerProcessSensitiveEnergyNorm = false
	If true, `PerProcessXxx` observables are normalized to the total energy in the sensitive volume. More...

std::vector< std::string >	fProcessName
	A std::vector storing the Geant4 name of the process corresponding to each process observable. More...

std::vector< std::string >	fProcessObservables

std::vector< std::string >	fProcessVolumeName
	A std::vector storing the volume name corresponding to each process observable. More...

std::vector< std::string >	fTrackCounterObservables
	A std::vector storing the observable name `xxxTracksCounter` for a given `xxx` particle. More...

std::vector< std::string >	fTracksEDepObservables
	A std::vector storing the observable name `xxxTracksEDep` for a given `xxx` particle. More...

std::vector< Int_t >	fVolumeID
	A std::vector storing the active volume ids of observables `xxxVolumeEDep`. More...

std::vector< Int_t >	fVolumeID2
	A std::vector storing the active volume ids corresponding mean position observable `xxxMeanPosX,Y,Z`. More...

std::vector< Int_t >	fVolumeID3
	A std::vector storing the active volume ids corresponding process observable . More...

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 Attributes inherited from TRestEventProcess
TRestAnalysisTree *	fAnalysisTree = nullptr

TCanvas *	fCanvas = nullptr
	< Canvas for some viewer event More...

TVector2	fCanvasSize
	Canvas size. More...

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

bool	fIsExternal = false
	It defines if the process reads event data from an external source. More...

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

bool	fReadOnly = false
	not used, keep for compatibility More...

TRestRun *	fRunInfo = nullptr
	< Pointer to TRestRun object where to find metadata. More...

bool	fSingleThreadOnly = false

bool	fValidateObservables = false
	It defines if observable names should be added to the validation list. More...

Protected Attributes inherited from TRestMetadata
std::string	configBuffer
	The buffer where the corresponding metadata section is stored. Filled only during Write() More...

std::string	fConfigFileName
	Full name of the rml file. More...

std::map< std::string, std::string >	fConstants
	Saving a list of rml constants. name-value std::pair. Constants are temporary for this class only. More...

TiXmlElement *	fElement
	Saving the sectional element together with global element. More...

TiXmlElement *	fElementGlobal
	Saving the global element, to be passed to the resident class, if necessary. More...

Bool_t	fError = false
	It can be used as a way to identify that something went wrong using SetError method. More...

TString	fErrorMessage = ""
	A std::string to store an optional error message through method SetError. More...

TRestManager *	fHostmgr
	All metadata classes can be initialized and managed by TRestManager. More...

Int_t	fNErrors = 0
	It counts the number of errors notified. More...

Int_t	fNWarnings = 0
	It counts the number of warnings notified. More...

std::string	fSectionName
	Section name given in the constructor of the derived metadata class. More...

Bool_t	fStore
	This variable is used to determine if the metadata structure should be stored in the ROOT file. More...

std::map< std::string, std::string >	fVariables
	Saving a list of rml variables. name-value std::pair. More...

TRestStringOutput::REST_Verbose_Level	fVerboseLevel
	Verbose level used to print debug info. More...

Bool_t	fWarning = false
	It can be used as a way to identify that something went wrong using SetWarning method. More...

TString	fWarningMessage = ""
	It can be used as a way to identify that something went wrong using SetWarning method. More...

std::string	messageBuffer
	The buffer to store the output message through TRestStringOutput in this class. More...

endl_t	RESTendl
	Termination flag object for TRestStringOutput. More...

Constructor & Destructor Documentation

◆ TRestGeant4AnalysisProcess() [1/2]

TRestGeant4AnalysisProcess::TRestGeant4AnalysisProcess ( )

Default constructor.

Definition at line 293 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

configFilename A const char* giving the path to an RML file.

Definition at line 307 of file TRestGeant4AnalysisProcess.cxx.

◆ ~TRestGeant4AnalysisProcess()

TRestGeant4AnalysisProcess::~TRestGeant4AnalysisProcess ( )

Default destructor.

Definition at line 316 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 944 of file TRestGeant4AnalysisProcess.cxx.

◆ GetAliasObservableNameToVolume()

std::map< std::string, std::string > TRestGeant4AnalysisProcess::GetAliasObservableNameToVolume ( )

protected

Definition at line 911 of file TRestGeant4AnalysisProcess.cxx.

◆ GetGeant4ProcessName()

string TRestGeant4AnalysisProcess::GetGeant4ProcessName ( const std::string & name ) const

It returns the Geant4 process name corresponding to name.

name can be a REST process name (see GetRestToGeant4ProcessNameMap) or a Geant4 process name with the first letter capitalized (e.g. Compt, HadElastic or NCapture). It returns an empty string if no match is found.

Definition at line 411 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 120 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 121 of file TRestGeant4AnalysisProcess.h.

◆ GetProcessName()

const char * TRestGeant4AnalysisProcess::GetProcessName ( ) const

inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 140 of file TRestGeant4AnalysisProcess.h.

◆ GetRestToGeant4ProcessNameMap()

const map< string, string > & TRestGeant4AnalysisProcess::GetRestToGeant4ProcessNameMap ( )

static

It returns the map between the process names used in REST observables (<volume><Process>Process) and the process names used by Geant4.

Definition at line 372 of file TRestGeant4AnalysisProcess.cxx.

◆ Initialize()

void TRestGeant4AnalysisProcess::Initialize ( )

overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 327 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, <volume><Process>Process, containsProcess and PerProcess observables defined in TRestGeant4AnalysisProcess are filled at this stage.

Reimplemented from TRestEventProcess.

Definition at line 465 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

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

Definition at line 348 of file TRestGeant4AnalysisProcess.cxx.

◆ LoadDefaultConfig()

void TRestGeant4AnalysisProcess::LoadDefaultConfig ( )

private

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

Definition at line 321 of file TRestGeant4AnalysisProcess.cxx.

◆ Maker()

TRestEventProcess * TRestGeant4AnalysisProcess::Maker ( )

inline

Returns a new instance of this class.

Definition at line 137 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 130 of file TRestGeant4AnalysisProcess.h.

◆ PrintNotActiveVolumeWarning()

void TRestGeant4AnalysisProcess::PrintNotActiveVolumeWarning ( const TString & volumeName )

private

It prints a warning when the volume used by an observable is not an active volume.

Definition at line 442 of file TRestGeant4AnalysisProcess.cxx.

◆ ProcessEvent()

TRestEvent * TRestGeant4AnalysisProcess::ProcessEvent ( TRestEvent * inputEvent )

overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 673 of file TRestGeant4AnalysisProcess.cxx.

Field Documentation

◆ fContainsProcessG4Name

std::vector<std::string> TRestGeant4AnalysisProcess::fContainsProcessG4Name

private

A std::vector storing the Geant4 process name corresponding to each containsProcessXxx observable.

Definition at line 78 of file TRestGeant4AnalysisProcess.h.

◆ fContainsProcessObservables

std::vector<std::string> TRestGeant4AnalysisProcess::fContainsProcessObservables

private

A std::vector storing the observable names containsProcessXxx.

Definition at line 75 of file TRestGeant4AnalysisProcess.h.

◆ 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 93 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 99 of file TRestGeant4AnalysisProcess.h.

◆ fPerProcessG4Names

std::vector<std::vector<std::string> > TRestGeant4AnalysisProcess::fPerProcessG4Names

private

The Geant4 process names contributing to each PerProcessXxx observable.

Definition at line 84 of file TRestGeant4AnalysisProcess.h.

◆ fPerProcessObservables

std::vector<std::string> TRestGeant4AnalysisProcess::fPerProcessObservables

private

A std::vector storing the observable names PerProcessXxx (only if fPerProcessSensitiveEnergy).

Definition at line 81 of file TRestGeant4AnalysisProcess.h.

◆ fPerProcessParticle

std::vector<std::string> TRestGeant4AnalysisProcess::fPerProcessParticle

private

The particle restriction of each PerProcessXxx observable (empty means any particle).

Definition at line 87 of file TRestGeant4AnalysisProcess.h.

◆ fPerProcessSensitiveEnergy

Bool_t TRestGeant4AnalysisProcess::fPerProcessSensitiveEnergy = false

private

If true, PerProcessXxx observables with the energy deposited in the sensitive volume per process are added to the analysis tree.

Definition at line 103 of file TRestGeant4AnalysisProcess.h.

◆ fPerProcessSensitiveEnergyNorm

Bool_t TRestGeant4AnalysisProcess::fPerProcessSensitiveEnergyNorm = false

private

If true, PerProcessXxx observables are normalized to the total energy in the sensitive volume.

Definition at line 105 of file TRestGeant4AnalysisProcess.h.

◆ fProcessName

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

private

A std::vector storing the Geant4 name of the process corresponding to each process observable.

Definition at line 72 of file TRestGeant4AnalysisProcess.h.

◆ fProcessObservables

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

private

A std::vector storing the name of observables xxxYyyProcess related to process Yyy in volume xxx.

Definition at line 63 of file TRestGeant4AnalysisProcess.h.

◆ fProcessVolumeName

std::vector<std::string> TRestGeant4AnalysisProcess::fProcessVolumeName

private

A std::vector storing the volume name corresponding to each process observable.

Definition at line 69 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 90 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 96 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 66 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:

Detailed Description

Volume names and aliases

Generic observables

Physics process observables

Sensitive volume observables

Primary and global observables

RML example

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRestGeant4AnalysisProcess() [1/2]

◆ TRestGeant4AnalysisProcess() [2/2]

◆ ~TRestGeant4AnalysisProcess()

Member Function Documentation

◆ EndProcess()

◆ GetAliasObservableNameToVolume()

◆ GetGeant4ProcessName()

◆ GetInputEvent()

◆ GetOutputEvent()

◆ GetProcessName()

◆ GetRestToGeant4ProcessNameMap()

◆ Initialize()

◆ InitProcess()

◆ LoadConfig()

◆ LoadDefaultConfig()

◆ Maker()

◆ PrintMetadata()

◆ PrintNotActiveVolumeWarning()

◆ ProcessEvent()

Field Documentation

◆ fContainsProcessG4Name

◆ fContainsProcessObservables

◆ fDirID

◆ fEnergyInObservables

◆ fG4Metadata

◆ fInputG4Event

◆ fMeanPosObservables

◆ fOutputG4Event

◆ fParticleTrackCounter

◆ fParticleTrackEdep

◆ fPerProcessG4Names

◆ fPerProcessObservables

◆ fPerProcessParticle

◆ fPerProcessSensitiveEnergy

◆ fPerProcessSensitiveEnergyNorm

◆ fProcessName

◆ fProcessObservables

◆ fProcessVolumeName

◆ fTrackCounterObservables

◆ fTracksEDepObservables

◆ fVolumeID

◆ fVolumeID2

◆ fVolumeID3

◆ fVolumeName