REST-for-Physics  v2.3
Rare Event Searches ToolKit for Physics
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
TRestGeant4VetoAnalysisProcess Class Reference

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 43 of file TRestGeant4VetoAnalysisProcess.h.

Inheritance diagram for TRestGeant4VetoAnalysisProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestGeant4VetoAnalysisProcess, 4)
 
void EndProcess () override
 Function to include required actions after all events have been processed. 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
 
std::string 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...
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 The main processing event function. More...
 
void SetGeant4Metadata (const TRestGeant4Metadata *metadata)
 
 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...
 
TRestAnalysisTreeGetAnalysisTree () const
 Return the local analysis tree (dummy) More...
 
TCanvas * GetCanvas () const
 Get canvas. More...
 
TRestAnalysisTreeGetFullAnalysisTree ()
 
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
 
TRestRunGetRunInfo () 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 TRestEventProcessEvent (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 ()
 

Static Public Member Functions

static Veto GetVetoFromString (const std::string &vetoString)
 

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 TRestGeant4MetadatafGeant4Metadata = nullptr
 
TRestGeant4EventfInputEvent = nullptr
 
TRestGeant4EventfOutputEvent = nullptr
 
std::vector< VetofVetoVolumes
 
std::string 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 ()
 
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 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...
 
TRestRunfRunInfo = 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...
 

Constructor & Destructor Documentation

◆ TRestGeant4VetoAnalysisProcess() [1/2]

TRestGeant4VetoAnalysisProcess::TRestGeant4VetoAnalysisProcess ( )

Definition at line 160 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ TRestGeant4VetoAnalysisProcess() [2/2]

TRestGeant4VetoAnalysisProcess::TRestGeant4VetoAnalysisProcess ( const char *  configFilename)

Definition at line 162 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ ~TRestGeant4VetoAnalysisProcess()

TRestGeant4VetoAnalysisProcess::~TRestGeant4VetoAnalysisProcess ( )

Definition at line 169 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 511 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ GetInputEvent()

RESTValue TRestGeant4VetoAnalysisProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 62 of file TRestGeant4VetoAnalysisProcess.h.

◆ GetOutputEvent()

RESTValue TRestGeant4VetoAnalysisProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 63 of file TRestGeant4VetoAnalysisProcess.h.

◆ GetProcessName()

const char * TRestGeant4VetoAnalysisProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 80 of file TRestGeant4VetoAnalysisProcess.h.

◆ GetVetoFromString()

Veto TRestGeant4VetoAnalysisProcess::GetVetoFromString ( const std::string &  vetoString)
static

Definition at line 105 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ GetVetoVolumesExpression()

std::string TRestGeant4VetoAnalysisProcess::GetVetoVolumesExpression ( ) const
inline

Definition at line 48 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 524 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 180 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ InitProcess()

void TRestGeant4VetoAnalysisProcess::InitProcess ( )
overridevirtual

Process initialization.

Reimplemented from TRestEventProcess.

Definition at line 208 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
configFilenameA const char* giving the path to an RML file.
nameThe name of the specific metadata. It will be used to find the corresponding TRestGeant4VetoAnalysisProcess section inside the RML.

Definition at line 199 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ LoadDefaultConfig()

void TRestGeant4VetoAnalysisProcess::LoadDefaultConfig ( )
private

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

Definition at line 174 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ PrintMetadata()

void TRestGeant4VetoAnalysisProcess::PrintMetadata ( )
overridevirtual

Implemented it in the derived metadata class to print out specific metadata information.

Prints metadata content on screen. Usually overloaded by the derived metadata class.

Reimplemented from TRestMetadata.

Definition at line 528 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ ProcessEvent()

TRestEvent * TRestGeant4VetoAnalysisProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 245 of file TRestGeant4VetoAnalysisProcess.cxx.

◆ SetGeant4Metadata()

void TRestGeant4VetoAnalysisProcess::SetGeant4Metadata ( const TRestGeant4Metadata metadata)
inline

Definition at line 67 of file TRestGeant4VetoAnalysisProcess.h.

Field Documentation

◆ fGeant4Metadata

const TRestGeant4Metadata* TRestGeant4VetoAnalysisProcess::fGeant4Metadata = nullptr
private

Definition at line 53 of file TRestGeant4VetoAnalysisProcess.h.

◆ fInputEvent

TRestGeant4Event* TRestGeant4VetoAnalysisProcess::fInputEvent = nullptr
private

Definition at line 51 of file TRestGeant4VetoAnalysisProcess.h.

◆ fOutputEvent

TRestGeant4Event* TRestGeant4VetoAnalysisProcess::fOutputEvent = nullptr
private

Definition at line 52 of file TRestGeant4VetoAnalysisProcess.h.

◆ fVetoVolumes

std::vector<Veto> TRestGeant4VetoAnalysisProcess::fVetoVolumes
private

Definition at line 55 of file TRestGeant4VetoAnalysisProcess.h.

◆ fVetoVolumesExpression

std::string TRestGeant4VetoAnalysisProcess::fVetoVolumesExpression
private

Definition at line 45 of file TRestGeant4VetoAnalysisProcess.h.


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