Detailed Description

The TRestGeant4VetoAnalysisProcess generates observables based on veto volumes energy depositions. It was first developed as a process for the IAXO experiment but can be used in any analysis. It uses keywords to identify different relevant volumes (such as vetoes). The default veto keyword for IAXO is veto and it will tag each volume containing the keyword as a veto volume, so avoid using the keyword on volumes that do not act as vetoes.

Parameters: vetoKeyword: keyword to identify a volume of the geometry as a veto. The condition is that the keyword is contained inside the name of the volume. Only volumes serving as veto (i.e. scintillators) should contain this vetoKeyword in their names. vetoGroupKeywords: comma separated keywords used to identify different groups of vetoes. This is an optional parameter that when specified will make the process return additional observables on a per group basis. The most common use case is using group names to identify the location of the vetoes (top, bottom, ...). The volumes detected as vetoes (via vetoKeyword) will also be assigned to a group if they contain a keyword contained in this list. vetoQuenchingFactors: comma separated values for the quenching factors used in the analysis. The observables will be calculated for each of the quenching factors contained in this list. Values between 0 and 1 only. This is useful in case the user doesn't know the exact value of the quenching factor. Also it is useful to insert 0 or 1 to study the effects of electromagnetic processes only, or no quenching at all.

Example usage: <parameter name="vetoKeyword" value="veto"> <parameter name="vetoGroupKeywords" value="top, bottom, east, west, front, back"> <parameter name="vetoQuenchingFactors" value="0, 0.15, 1">

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2020-September: Implementation.

Author: Luis Obis

Definition at line 31 of file TRestGeant4VetoAnalysisProcess.h.

Inheritance diagram for TRestGeant4VetoAnalysisProcess:

Public Member Functions
	ClassDefOverride (TRestGeant4VetoAnalysisProcess, 2)

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

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

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

const char *	GetProcessName () const override

TString	GetVetoDetectorExpression () const

double	GetVetoDetectorOffsetSize () const

double	GetVetoLightAttenuation () const

double	GetVetoQuenchingFactor () const

TString	GetVetoVolumesExpression () const

void	InitProcess () override
	Process initialization. More...

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

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

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

void	SetGeant4Metadata (const TRestGeant4Metadata *metadata)

void	SetVetoDetectorOffsetSize (double offset)

void	SetVetoDetectorsExpression (const TString &expression)

void	SetVetoLightAttenuation (double attenuation)

void	SetVetoQuenchingFactor (double quenchingFactor)

void	SetVetoVolumesExpression (const TString &expression)

	TRestGeant4VetoAnalysisProcess (const char *configFilename)

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

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 &)=delete

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)
	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)
	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 &)=delete

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

Private Member Functions
void	InitFromConfigFile () override
	Function to read input parameters from the RML TRestGeant4VetoAnalysisProcess metadata section. More...

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

Private Attributes
const TRestGeant4Metadata *	fGeant4Metadata = nullptr

TRestGeant4Event *	fInputEvent = nullptr

TRestGeant4Event *	fOutputEvent = nullptr

std::map< TString, TVector3 >	fVetoDetectorBoundaryDirection

std::map< TString, TVector3 >	fVetoDetectorBoundaryPosition

double	fVetoDetectorOffsetSize = 0

TString	fVetoDetectorsExpression

std::vector< TString >	fVetoDetectorVolumes

double	fVetoLightAttenuation = 0

double	fVetoQuenchingFactor = 1.0

std::vector< TString >	fVetoVolumes

TString	fVetoVolumesExpression

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

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

◆ TRestGeant4VetoAnalysisProcess() [1/2]

TRestGeant4VetoAnalysisProcess::TRestGeant4VetoAnalysisProcess ( )

Definition at line 72 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ TRestGeant4VetoAnalysisProcess() [2/2]

TRestGeant4VetoAnalysisProcess::TRestGeant4VetoAnalysisProcess ( const char * configFilename )

Definition at line 74 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ ~TRestGeant4VetoAnalysisProcess()

TRestGeant4VetoAnalysisProcess::~TRestGeant4VetoAnalysisProcess ( )

Definition at line 81 of file TRestGeant4VetoAnalysisProcess.cxx.

Member Function Documentation

◆ EndProcess()

void TRestGeant4VetoAnalysisProcess::EndProcess ( )

overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 310 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ GetInputEvent()

any TRestGeant4VetoAnalysisProcess::GetInputEvent ( ) const

inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 69 of file TRestGeant4VetoAnalysisProcess.h.

◆ GetOutputEvent()

any TRestGeant4VetoAnalysisProcess::GetOutputEvent ( ) const

inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 70 of file TRestGeant4VetoAnalysisProcess.h.

◆ GetProcessName()

const char * TRestGeant4VetoAnalysisProcess::GetProcessName ( ) const

inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 85 of file TRestGeant4VetoAnalysisProcess.h.

◆ GetVetoDetectorExpression()

TString TRestGeant4VetoAnalysisProcess::GetVetoDetectorExpression ( ) const

inline

Definition at line 41 of file TRestGeant4VetoAnalysisProcess.h.

◆ GetVetoDetectorOffsetSize()

double TRestGeant4VetoAnalysisProcess::GetVetoDetectorOffsetSize ( ) const

inline

Definition at line 42 of file TRestGeant4VetoAnalysisProcess.h.

◆ GetVetoLightAttenuation()

double TRestGeant4VetoAnalysisProcess::GetVetoLightAttenuation ( ) const

inline

Definition at line 43 of file TRestGeant4VetoAnalysisProcess.h.

◆ GetVetoQuenchingFactor()

double TRestGeant4VetoAnalysisProcess::GetVetoQuenchingFactor ( ) const

inline

Definition at line 44 of file TRestGeant4VetoAnalysisProcess.h.

◆ GetVetoVolumesExpression()

TString TRestGeant4VetoAnalysisProcess::GetVetoVolumesExpression ( ) const

inline

Definition at line 40 of file TRestGeant4VetoAnalysisProcess.h.

◆ InitFromConfigFile()

void TRestGeant4VetoAnalysisProcess::InitFromConfigFile ( )

overrideprivatevirtual

Function to read input parameters from the RML TRestGeant4VetoAnalysisProcess metadata section.

Reimplemented from TRestEventProcess.

Definition at line 323 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ Initialize()

void TRestGeant4VetoAnalysisProcess::Initialize ( )

overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 92 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ InitProcess()

void TRestGeant4VetoAnalysisProcess::InitProcess ( )

overridevirtual

Process initialization.

Reimplemented from TRestEventProcess.

Definition at line 118 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ LoadConfig()

void TRestGeant4VetoAnalysisProcess::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 TRestGeant4VetoAnalysisProcess section inside the RML.

Definition at line 111 of file TRestGeant4VetoAnalysisProcess.cxx.