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

Detailed Description




         RESTSoft : Software for Rare Event Searches with TPCs

         TRestDetectorAvalancheProcess.h

         feb 2016:   First concept
             Created as part of the conceptualization of existing REST
             software.
             Javier G. Garza

Definition at line 24 of file TRestDetectorAvalancheProcess.h.

#include <TRestDetectorAvalancheProcess.h>

Inheritance diagram for TRestDetectorAvalancheProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestDetectorAvalancheProcess, 1)
 
void EndProcess () override
 To be executed at the end of the run (outside event loop) More...
 
Double_t GetDetectorGain () const
 
Double_t GetEnergyReference () const
 
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...
 
TRestMetadataGetProcessMetadata () const
 
const char * GetProcessName () const override
 
Double_t GetResolutionReference () const
 
void InitProcess () override
 To be executed at the beginning of the run (outside event loop) More...
 
void LoadConfig (std::string configFilename)
 
void PrintMetadata () override
 Implemented it in the derived metadata class to print out specific metadata information. More...
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 Process one event. More...
 
 TRestDetectorAvalancheProcess (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 ()
 

Protected Attributes

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

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
 Making default settings. More...
 
void LoadDefaultConfig ()
 

Private Attributes

Double_t fDetectorGain
 Detector's gain. More...
 
Double_t fEnergyRef
 reference energy for the FWHM More...
 
TRestDetectorHitsEventfHitsInputEvent
 
TRestDetectorHitsEventfHitsOutputEvent
 
Double_t fResolutionAtEref
 FWHM at Energy of reference. 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...
 

Constructor & Destructor Documentation

◆ TRestDetectorAvalancheProcess() [1/2]

TRestDetectorAvalancheProcess::TRestDetectorAvalancheProcess ( )

Definition at line 30 of file TRestDetectorAvalancheProcess.cxx.

◆ TRestDetectorAvalancheProcess() [2/2]

TRestDetectorAvalancheProcess::TRestDetectorAvalancheProcess ( const char *  configFilename)

Definition at line 32 of file TRestDetectorAvalancheProcess.cxx.

◆ ~TRestDetectorAvalancheProcess()

TRestDetectorAvalancheProcess::~TRestDetectorAvalancheProcess ( )

Definition at line 43 of file TRestDetectorAvalancheProcess.cxx.

Member Function Documentation

◆ EndProcess()

void TRestDetectorAvalancheProcess::EndProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 124 of file TRestDetectorAvalancheProcess.cxx.

◆ GetDetectorGain()

Double_t TRestDetectorAvalancheProcess::GetDetectorGain ( ) const
inline

Definition at line 67 of file TRestDetectorAvalancheProcess.h.

◆ GetEnergyReference()

Double_t TRestDetectorAvalancheProcess::GetEnergyReference ( ) const
inline

Definition at line 65 of file TRestDetectorAvalancheProcess.h.

◆ GetInputEvent()

RESTValue TRestDetectorAvalancheProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 42 of file TRestDetectorAvalancheProcess.h.

◆ GetOutputEvent()

RESTValue TRestDetectorAvalancheProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 43 of file TRestDetectorAvalancheProcess.h.

◆ GetProcessMetadata()

TRestMetadata * TRestDetectorAvalancheProcess::GetProcessMetadata ( ) const
inline

Definition at line 61 of file TRestDetectorAvalancheProcess.h.

◆ GetProcessName()

const char * TRestDetectorAvalancheProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 63 of file TRestDetectorAvalancheProcess.h.

◆ GetResolutionReference()

Double_t TRestDetectorAvalancheProcess::GetResolutionReference ( ) const
inline

Definition at line 66 of file TRestDetectorAvalancheProcess.h.

◆ InitFromConfigFile()

void TRestDetectorAvalancheProcess::InitFromConfigFile ( )
overrideprivatevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 133 of file TRestDetectorAvalancheProcess.cxx.

◆ Initialize()

void TRestDetectorAvalancheProcess::Initialize ( )
overrideprivatevirtual

Making default settings.

Reimplemented from TRestMetadata.

Definition at line 56 of file TRestDetectorAvalancheProcess.cxx.

◆ InitProcess()

void TRestDetectorAvalancheProcess::InitProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 78 of file TRestDetectorAvalancheProcess.cxx.

◆ LoadConfig()

void TRestDetectorAvalancheProcess::LoadConfig ( std::string  configFilename)

Definition at line 70 of file TRestDetectorAvalancheProcess.cxx.

◆ LoadDefaultConfig()

void TRestDetectorAvalancheProcess::LoadDefaultConfig ( )
private

Definition at line 48 of file TRestDetectorAvalancheProcess.cxx.

◆ PrintMetadata()

void TRestDetectorAvalancheProcess::PrintMetadata ( )
inlineoverridevirtual

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 51 of file TRestDetectorAvalancheProcess.h.

◆ ProcessEvent()

TRestEvent * TRestDetectorAvalancheProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

Process one event.

Implements TRestEventProcess.

Definition at line 89 of file TRestDetectorAvalancheProcess.cxx.

Field Documentation

◆ fDetectorGain

Double_t TRestDetectorAvalancheProcess::fDetectorGain
private

Detector's gain.

Definition at line 31 of file TRestDetectorAvalancheProcess.h.

◆ fEnergyRef

Double_t TRestDetectorAvalancheProcess::fEnergyRef
private

reference energy for the FWHM

Definition at line 29 of file TRestDetectorAvalancheProcess.h.

◆ fGas

TRestDetectorGas* TRestDetectorAvalancheProcess::fGas
protected

Definition at line 39 of file TRestDetectorAvalancheProcess.h.

◆ fHitsInputEvent

TRestDetectorHitsEvent* TRestDetectorAvalancheProcess::fHitsInputEvent
private

Definition at line 26 of file TRestDetectorAvalancheProcess.h.

◆ fHitsOutputEvent

TRestDetectorHitsEvent* TRestDetectorAvalancheProcess::fHitsOutputEvent
private

Definition at line 27 of file TRestDetectorAvalancheProcess.h.

◆ fResolutionAtEref

Double_t TRestDetectorAvalancheProcess::fResolutionAtEref
private

FWHM at Energy of reference.

Definition at line 30 of file TRestDetectorAvalancheProcess.h.


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