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

Detailed Description

RESTSoft : Software for Rare Event Searches with TPCs

TRestDetectorHitsReductionProcess.h

Nov 2016 : Javier Galan

Definition at line 18 of file TRestDetectorHitsReductionProcess.h.

#include <TRestDetectorHitsReductionProcess.h>

Inheritance diagram for TRestDetectorHitsReductionProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestDetectorHitsReductionProcess, 1)
 
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
 
void InitProcess () override
 To be executed at the beginning of the run (outside event loop) More...
 
void LoadConfig (const std::string &configFilename, const std::string &name="")
 
void LoadDefaultConfig ()
 
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...
 
 TRestDetectorHitsReductionProcess (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

Double_t fDistanceFactor
 
Double_t fMaxNodes
 
Double_t fMinimumDistance
 
Double_t fStartingDistance
 
- 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...
 

Private Attributes

TRestDetectorHitsEventfInputHitsEvent
 
TRestDetectorHitsEventfOutputHitsEvent
 

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

◆ TRestDetectorHitsReductionProcess() [1/2]

TRestDetectorHitsReductionProcess::TRestDetectorHitsReductionProcess ( )

Definition at line 20 of file TRestDetectorHitsReductionProcess.cxx.

◆ TRestDetectorHitsReductionProcess() [2/2]

TRestDetectorHitsReductionProcess::TRestDetectorHitsReductionProcess ( const char *  configFilename)

Definition at line 22 of file TRestDetectorHitsReductionProcess.cxx.

◆ ~TRestDetectorHitsReductionProcess()

TRestDetectorHitsReductionProcess::~TRestDetectorHitsReductionProcess ( )

Definition at line 29 of file TRestDetectorHitsReductionProcess.cxx.

Member Function Documentation

◆ EndProcess()

void TRestDetectorHitsReductionProcess::EndProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 102 of file TRestDetectorHitsReductionProcess.cxx.

◆ GetInputEvent()

RESTValue TRestDetectorHitsReductionProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 34 of file TRestDetectorHitsReductionProcess.h.

◆ GetOutputEvent()

RESTValue TRestDetectorHitsReductionProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 35 of file TRestDetectorHitsReductionProcess.h.

◆ GetProcessName()

const char * TRestDetectorHitsReductionProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 55 of file TRestDetectorHitsReductionProcess.h.

◆ InitFromConfigFile()

void TRestDetectorHitsReductionProcess::InitFromConfigFile ( )
overrideprivatevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 104 of file TRestDetectorHitsReductionProcess.cxx.

◆ Initialize()

void TRestDetectorHitsReductionProcess::Initialize ( )
overrideprivatevirtual

Making default settings.

Reimplemented from TRestMetadata.

Definition at line 41 of file TRestDetectorHitsReductionProcess.cxx.

◆ InitProcess()

void TRestDetectorHitsReductionProcess::InitProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 53 of file TRestDetectorHitsReductionProcess.cxx.

◆ LoadConfig()

void TRestDetectorHitsReductionProcess::LoadConfig ( const std::string &  configFilename,
const std::string &  name = "" 
)

Definition at line 49 of file TRestDetectorHitsReductionProcess.cxx.

◆ LoadDefaultConfig()

void TRestDetectorHitsReductionProcess::LoadDefaultConfig ( )

Definition at line 31 of file TRestDetectorHitsReductionProcess.cxx.

◆ PrintMetadata()

void TRestDetectorHitsReductionProcess::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 44 of file TRestDetectorHitsReductionProcess.h.

◆ ProcessEvent()

TRestEvent * TRestDetectorHitsReductionProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

Process one event.

Implements TRestEventProcess.

Definition at line 55 of file TRestDetectorHitsReductionProcess.cxx.

Field Documentation

◆ fDistanceFactor

Double_t TRestDetectorHitsReductionProcess::fDistanceFactor
protected

Definition at line 30 of file TRestDetectorHitsReductionProcess.h.

◆ fInputHitsEvent

TRestDetectorHitsEvent* TRestDetectorHitsReductionProcess::fInputHitsEvent
private

Definition at line 20 of file TRestDetectorHitsReductionProcess.h.

◆ fMaxNodes

Double_t TRestDetectorHitsReductionProcess::fMaxNodes
protected

Definition at line 31 of file TRestDetectorHitsReductionProcess.h.

◆ fMinimumDistance

Double_t TRestDetectorHitsReductionProcess::fMinimumDistance
protected

Definition at line 29 of file TRestDetectorHitsReductionProcess.h.

◆ fOutputHitsEvent

TRestDetectorHitsEvent* TRestDetectorHitsReductionProcess::fOutputHitsEvent
private

Definition at line 21 of file TRestDetectorHitsReductionProcess.h.

◆ fStartingDistance

Double_t TRestDetectorHitsReductionProcess::fStartingDistance
protected

Definition at line 28 of file TRestDetectorHitsReductionProcess.h.


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