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

Detailed Description

Recomputes the energy of every hit based on quenching factor for each particle and volume.

Definition at line 32 of file TRestGeant4QuenchingProcess.h.

#include <TRestGeant4QuenchingProcess.h>

Inheritance diagram for TRestGeant4QuenchingProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestGeant4QuenchingProcess, 2)
 
void EndProcess () override
 To be executed at the end of the run (outside event loop) 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...
 
std::set< std::string > GetUserVolumeExpressions () const
 
std::set< std::string > GetVolumes () const
 
void InitProcess () override
 Process initialization. User volume expressions are matched to physical volumes. More...
 
void LoadConfig (const std::string &configFilename, const std::string &name="")
 Function to load the configuration from an external configuration file. More...
 
TRestEventProcessMaker ()
 Returns a new instance of this class. 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...
 
 TRestGeant4QuenchingProcess ()
 Default constructor. More...
 
 TRestGeant4QuenchingProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestGeant4QuenchingProcess () 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
 To make settings from rml file. This method must be implemented in the derived class. 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

TRestGeant4MetadatafGeant4Metadata {}
 A pointer to the simulation metadata information accessible to TRestRun. More...
 
TRestGeant4EventfInputG4Event {}
 A pointer to the specific TRestGeant4Event input. More...
 
TRestGeant4EventfOutputG4Event {}
 A pointer to the specific TRestGeant4Event output. More...
 
std::set< std::string > fUserVolumeExpressions
 
std::set< std::string > fVolumes
 

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

◆ TRestGeant4QuenchingProcess() [1/2]

TRestGeant4QuenchingProcess::TRestGeant4QuenchingProcess ( )

Default constructor.

Definition at line 56 of file TRestGeant4QuenchingProcess.cxx.

◆ TRestGeant4QuenchingProcess() [2/2]

TRestGeant4QuenchingProcess::TRestGeant4QuenchingProcess ( 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 70 of file TRestGeant4QuenchingProcess.cxx.

◆ ~TRestGeant4QuenchingProcess()

TRestGeant4QuenchingProcess::~TRestGeant4QuenchingProcess ( )
override

Default destructor.

Definition at line 81 of file TRestGeant4QuenchingProcess.cxx.

Member Function Documentation

◆ EndProcess()

void TRestGeant4QuenchingProcess::EndProcess ( )
overridevirtual

To be executed at the end of the run (outside event loop)

Reimplemented from TRestEventProcess.

Definition at line 243 of file TRestGeant4QuenchingProcess.cxx.

◆ GetInputEvent()

RESTValue TRestGeant4QuenchingProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 54 of file TRestGeant4QuenchingProcess.h.

◆ GetOutputEvent()

RESTValue TRestGeant4QuenchingProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 55 of file TRestGeant4QuenchingProcess.h.

◆ GetProcessName()

const char * TRestGeant4QuenchingProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 69 of file TRestGeant4QuenchingProcess.h.

◆ GetUserVolumeExpressions()

std::set< std::string > TRestGeant4QuenchingProcess::GetUserVolumeExpressions ( ) const

Definition at line 255 of file TRestGeant4QuenchingProcess.cxx.

◆ GetVolumes()

std::set< std::string > TRestGeant4QuenchingProcess::GetVolumes ( ) const

Definition at line 253 of file TRestGeant4QuenchingProcess.cxx.

◆ InitFromConfigFile()

void TRestGeant4QuenchingProcess::InitFromConfigFile ( )
overrideprivatevirtual

To make settings from rml file. This method must be implemented in the derived class.

Reimplemented from TRestEventProcess.

Definition at line 119 of file TRestGeant4QuenchingProcess.cxx.

◆ Initialize()

void TRestGeant4QuenchingProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 92 of file TRestGeant4QuenchingProcess.cxx.

◆ InitProcess()

void TRestGeant4QuenchingProcess::InitProcess ( )
overridevirtual

Process initialization. User volume expressions are matched to physical volumes.

Reimplemented from TRestEventProcess.

Definition at line 134 of file TRestGeant4QuenchingProcess.cxx.

◆ LoadConfig()

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

Definition at line 113 of file TRestGeant4QuenchingProcess.cxx.

◆ LoadDefaultConfig()

void TRestGeant4QuenchingProcess::LoadDefaultConfig ( )
private

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

Definition at line 86 of file TRestGeant4QuenchingProcess.cxx.

◆ Maker()

TRestEventProcess * TRestGeant4QuenchingProcess::Maker ( )
inline

Returns a new instance of this class.

Definition at line 66 of file TRestGeant4QuenchingProcess.h.

◆ PrintMetadata()

void TRestGeant4QuenchingProcess::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 245 of file TRestGeant4QuenchingProcess.cxx.

◆ ProcessEvent()

TRestEvent * TRestGeant4QuenchingProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 185 of file TRestGeant4QuenchingProcess.cxx.

Field Documentation

◆ fGeant4Metadata

TRestGeant4Metadata* TRestGeant4QuenchingProcess::fGeant4Metadata {}
private

A pointer to the simulation metadata information accessible to TRestRun.

Definition at line 41 of file TRestGeant4QuenchingProcess.h.

◆ fInputG4Event

TRestGeant4Event* TRestGeant4QuenchingProcess::fInputG4Event {}
private

A pointer to the specific TRestGeant4Event input.

Definition at line 35 of file TRestGeant4QuenchingProcess.h.

◆ fOutputG4Event

TRestGeant4Event* TRestGeant4QuenchingProcess::fOutputG4Event {}
private

A pointer to the specific TRestGeant4Event output.

Definition at line 38 of file TRestGeant4QuenchingProcess.h.

◆ fUserVolumeExpressions

std::set<std::string> TRestGeant4QuenchingProcess::fUserVolumeExpressions
private

Definition at line 43 of file TRestGeant4QuenchingProcess.h.

◆ fVolumes

std::set<std::string> TRestGeant4QuenchingProcess::fVolumes
private

Definition at line 44 of file TRestGeant4QuenchingProcess.h.


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