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

Detailed Description

A process to transform a TRestGeant4Event into a TRestDetectorHitsEvent.

This process allows to select the GDML geometry volumes (defined in TRestGeant4Metadata) that will be transferred to the TRestDetectorHitsEvent by using the <volume key inside the process definition.

The following example shows how to include the process into TRestProcessRunner RML definition. In this particular example we extract hits from gas and vessel volumes defined in the geometry. Any other hits will be ignored.

<addProcess type="TRestGeant4ToDetectorHitsProcess" name="g4ToHits" value="ON">
<volume name="gas"/>
<volume name="vessel"/>
</addProcess>

If no volumes are defined using the <volume key, all volumes will be active, and all hits will be transferred to the TRestDetectorHitsEvent output.


RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2016-October First implementation of TRestGeant4Event to TRestDetectorHitsEvent Igor Irastorza

2017-October: Added the possibility to extract hits only from selected geometrical volumes Javier Galan

Author
Igor Irastorza
Javier Galan

Definition at line 35 of file TRestGeant4ToDetectorHitsProcess.h.

#include <TRestGeant4ToDetectorHitsProcess.h>

Inheritance diagram for TRestGeant4ToDetectorHitsProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestGeant4ToDetectorHitsProcess, 2)
 
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. This process accesses the information inside TRestGeant4Metadata to identify the geometry volume ids associated to the hits. 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
 It prints on screen relevant data members from this class. More...
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 The main processing event function. More...
 
 TRestGeant4ToDetectorHitsProcess ()
 Default constructor. More...
 
 TRestGeant4ToDetectorHitsProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestGeant4ToDetectorHitsProcess () override
 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...
 
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 ()
 

Private Member Functions

void InitFromConfigFile () override
 Function to read input parameters from the RML TRestGeant4ToDetectorHitsProcess 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

TRestGeant4EventfGeant4Event
 A pointer to the input TRestGeant4Event. More...
 
TRestGeant4MetadatafGeant4Metadata
 A pointer to the Geant4 simulation conditions stored in TRestGeant4Metadata. More...
 
TRestDetectorHitsEventfHitsEvent
 A pointer to the output TRestDetectorHitsEvent. More...
 
std::map< std::string, REST_HitType > fHitTypes
 
std::vector< Int_t > fVolumeId
 The volume ids from the volumes selected for transfer to TRestDetectorHitsEvent. More...
 
std::vector< TString > fVolumeSelection
 The geometry volume names to be transferred to TRestDetectorHitsEvent. More...
 

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

◆ TRestGeant4ToDetectorHitsProcess() [1/2]

TRestGeant4ToDetectorHitsProcess::TRestGeant4ToDetectorHitsProcess ( )

Default constructor.

Definition at line 71 of file TRestGeant4ToDetectorHitsProcess.cxx.

◆ TRestGeant4ToDetectorHitsProcess() [2/2]

TRestGeant4ToDetectorHitsProcess::TRestGeant4ToDetectorHitsProcess ( const char *  configFilename)
explicit

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 85 of file TRestGeant4ToDetectorHitsProcess.cxx.

◆ ~TRestGeant4ToDetectorHitsProcess()

TRestGeant4ToDetectorHitsProcess::~TRestGeant4ToDetectorHitsProcess ( )
override

Default destructor.

Definition at line 96 of file TRestGeant4ToDetectorHitsProcess.cxx.

Member Function Documentation

◆ GetInputEvent()

RESTValue TRestGeant4ToDetectorHitsProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 64 of file TRestGeant4ToDetectorHitsProcess.h.

◆ GetOutputEvent()

RESTValue TRestGeant4ToDetectorHitsProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 66 of file TRestGeant4ToDetectorHitsProcess.h.

◆ GetProcessName()

const char * TRestGeant4ToDetectorHitsProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 77 of file TRestGeant4ToDetectorHitsProcess.h.

◆ InitFromConfigFile()

void TRestGeant4ToDetectorHitsProcess::InitFromConfigFile ( )
overrideprivatevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 263 of file TRestGeant4ToDetectorHitsProcess.cxx.

◆ Initialize()

void TRestGeant4ToDetectorHitsProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 111 of file TRestGeant4ToDetectorHitsProcess.cxx.

◆ InitProcess()

void TRestGeant4ToDetectorHitsProcess::InitProcess ( )
overridevirtual

Process initialization. This process accesses the information inside TRestGeant4Metadata to identify the geometry volume ids associated to the hits.

Reimplemented from TRestEventProcess.

Definition at line 139 of file TRestGeant4ToDetectorHitsProcess.cxx.

◆ LoadConfig()

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

Definition at line 131 of file TRestGeant4ToDetectorHitsProcess.cxx.

◆ LoadDefaultConfig()

void TRestGeant4ToDetectorHitsProcess::LoadDefaultConfig ( )
private

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

Definition at line 101 of file TRestGeant4ToDetectorHitsProcess.cxx.

◆ PrintMetadata()

void TRestGeant4ToDetectorHitsProcess::PrintMetadata ( )
overridevirtual

It prints on screen relevant data members from this class.

Reimplemented from TRestMetadata.

Definition at line 328 of file TRestGeant4ToDetectorHitsProcess.cxx.

◆ ProcessEvent()

TRestEvent * TRestGeant4ToDetectorHitsProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 198 of file TRestGeant4ToDetectorHitsProcess.cxx.

Field Documentation

◆ fGeant4Event

TRestGeant4Event* TRestGeant4ToDetectorHitsProcess::fGeant4Event
private

A pointer to the input TRestGeant4Event.

Definition at line 38 of file TRestGeant4ToDetectorHitsProcess.h.

◆ fGeant4Metadata

TRestGeant4Metadata* TRestGeant4ToDetectorHitsProcess::fGeant4Metadata
private

A pointer to the Geant4 simulation conditions stored in TRestGeant4Metadata.

Definition at line 41 of file TRestGeant4ToDetectorHitsProcess.h.

◆ fHitsEvent

TRestDetectorHitsEvent* TRestGeant4ToDetectorHitsProcess::fHitsEvent
private

A pointer to the output TRestDetectorHitsEvent.

Definition at line 44 of file TRestGeant4ToDetectorHitsProcess.h.

◆ fHitTypes

std::map<std::string, REST_HitType> TRestGeant4ToDetectorHitsProcess::fHitTypes
private

Definition at line 52 of file TRestGeant4ToDetectorHitsProcess.h.

◆ fVolumeId

std::vector<Int_t> TRestGeant4ToDetectorHitsProcess::fVolumeId
private

The volume ids from the volumes selected for transfer to TRestDetectorHitsEvent.

Definition at line 47 of file TRestGeant4ToDetectorHitsProcess.h.

◆ fVolumeSelection

std::vector<TString> TRestGeant4ToDetectorHitsProcess::fVolumeSelection
private

The geometry volume names to be transferred to TRestDetectorHitsEvent.

Definition at line 50 of file TRestGeant4ToDetectorHitsProcess.h.


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