REST-for-Physics  v2.3
Rare Event Searches ToolKit for Physics
Loading...
Searching...
No Matches
TRestEventRateAnalysisProcess Class Reference

Detailed Description

A pure analysis process used to calculate event rates and other time observables.

This process adds observables related to the event time and measured rate to the analysis tree.

Inside a TRestProcessRunner chain this process might be added as follows:

or

Observables

  • SecondsFromStart: It takes the time of the event and subtracts the time of the first event.
  • HoursFromStart: SecondsFromStart divided by 3600.
  • EventTimeDelay: It counts the time from the previous event to the present one.
  • MeanRate_InHz: It records the mean rate using the last 10 events. It divides 10 by the time in seconds between the first and the last entry.

You may add filters to any observable inside the analysis tree. To add a cut, write "cut" sections in your rml file:


Warning
⚠ REST is under continuous development. This documentation is offered to you by the REST community. Your HELP is needed to keep this code up to date. Your feedback will be worth to support this software, please report any problems/suggestions you may find will using it at The REST Framework forum. You are welcome to contribute fixing typos, updating information or adding/proposing new contributions. See also our Contribution Guide.

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2022-February: Transfering rate observables from TRestRawSignalAnalysisProcess

Author
Javier Galan

Definition at line 29 of file TRestEventRateAnalysisProcess.h.

#include <TRestEventRateAnalysisProcess.h>

Inheritance diagram for TRestEventRateAnalysisProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestEventRateAnalysisProcess, 1)
RESTValue GetInputEvent () const override
 Get pointer to input event. Must be implemented in the derived class.
RESTValue GetOutputEvent () const override
 Get pointer to output event. Must be implemented in the derived class.
const char * GetProcessName () const override
void InitProcess () override
 Process initialization.
void PrintMetadata () override
 Implemented it in the derived metadata class to print out specific metadata information.
TRestEvent * ProcessEvent (TRestEvent *inputEvent) override
 The main processing event function.
 TRestEventRateAnalysisProcess ()
 Default constructor.
 ~TRestEventRateAnalysisProcess ()
 Default destructor.
Public Member Functions inherited from TRestEventProcess
virtual Bool_t AddInputFile (const std::string &file)
bool ApplyCut ()
 Apply cut according to the cut conditions saved in fCut.
virtual void BeginOfEventProcess (TRestEvent *inputEvent=nullptr)
 Begin of event process, preparation work. Called right before ProcessEvent().
 ClassDefOverride (TRestEventProcess, 3)
virtual void EndOfEventProcess (TRestEvent *inputEvent=nullptr)
 End of event process. Nothing to do. Called directly after ProcessEvent().
virtual void EndProcess ()
 To be executed at the end of the run (outside event loop).
TRestAnalysisTree * GetAnalysisTree () const
 Return the local analysis tree (dummy).
TCanvas * GetCanvas () const
 Get canvas.
TRestAnalysisTree * GetFullAnalysisTree ()
 Get the full analysis tree from TRestRun, with non-empty entries.
std::vector< std::string > GetListOfAddedObservables ()
 Get list of observables, convert map to vector.
TRestRun * GetRunInfo () const
 Return the pointer of the hosting TRestRun object.
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.
virtual void InitFromConfigFile () override
 To make settings from rml file. This method must be implemented in the derived class.
Bool_t isExternal () const
 Return whether this process is external process.
Int_t LoadSectionMetadata () override
 Load extra section metadata: outputlevel after calling TRestMetadata::LoadSectionMetadata().
virtual void NotifyAnalysisTreeReset ()
 In case the analysis tree is reset(switched to new file), some process needs to have action.
virtual Bool_t OpenInputFiles (const std::vector< std::string > &files)
 Interface to external file reading, open input file. To be implemented in external processes.
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.
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.
Bool_t singleThreadOnly () const
 Return whether this process is single std::thread only.
 TRestEventProcess ()
 ~TRestEventProcess ()

Private Member Functions

void Initialize () override
 Function to initialize input/output event members and define the section name.

Private Attributes

TRestEvent * fEvent
 A pointer to the input event.
Double_t fFirstEventTime
 It registers the timestamp from the first event to calculate time from start observables.
std::vector< Double_t > fPreviousEventTime
 It keeps a historic list of timestamps of the previous N events. Now fixed to N=10 events.
bool fRateAnalysis = false
 It indicates whether to add rate observables which is correct only under single thread run.

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.
void EndPrintProcess ()
 Pre-defined printer, can be used at the ending in the implementation of PrintMetadata().
TRestEventProcess * GetFriend (const std::string &nameOrType)
 Get friendly TRestEventProcess object.
TRestEventProcess * GetFriendLive (const std::string &nameOrType)
 Get friendly TRestEventProcess object.
template<class T>
T * GetMetadata ()
 Get a metadata object from the host TRestRun.
TRestMetadata * GetMetadata (const std::string &nameOrType)
 Get a metadata object from the host TRestRun.
size_t GetNumberOfParallelProcesses () const
template<class T>
T GetObservableValue (const std::string &name)
TRestEventProcess * GetParallel (int i)
 Get a list of parallel processes from this process.
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.
template<class T>
void SetObservableValue (const std::string &name, const T &value)
 Set observable value for AnalysisTree.
Protected Attributes inherited from TRestEventProcess
TRestAnalysisTree * fAnalysisTree = nullptr
TCanvas * fCanvas = nullptr
 < Canvas for some viewer event
TVector2 fCanvasSize
 Canvas size.
std::vector< std::pair< std::string, TVector2 > > fCuts
 Stores cut definitions. Any listed observables should be in the range.
bool fDynamicObs = false
 It defines whether to use added observables only or all the observables appear in the code.
bool fIsExternal = false
 It defines if the process reads event data from an external source.
std::map< std::string, int > fObservablesDefined
 Stores the list of all the appeared process observables in the code.
std::map< std::string, int > fObservablesUpdated
 Stores the list of process observables updated when processing this event.
bool fReadOnly = false
 not used, keep for compatibility
TRestRun * fRunInfo = nullptr
 < Pointer to TRestRun object where to find metadata.
bool fSingleThreadOnly = false
bool fValidateObservables = false
 It defines if observable names should be added to the validation list.

Constructor & Destructor Documentation

◆ TRestEventRateAnalysisProcess()

TRestEventRateAnalysisProcess::TRestEventRateAnalysisProcess ( )

Default constructor.

Definition at line 101 of file TRestEventRateAnalysisProcess.cxx.

◆ ~TRestEventRateAnalysisProcess()

TRestEventRateAnalysisProcess::~TRestEventRateAnalysisProcess ( )

Default destructor.

Definition at line 106 of file TRestEventRateAnalysisProcess.cxx.

Member Function Documentation

◆ GetInputEvent()

RESTValue TRestEventRateAnalysisProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 49 of file TRestEventRateAnalysisProcess.h.

◆ GetOutputEvent()

RESTValue TRestEventRateAnalysisProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 50 of file TRestEventRateAnalysisProcess.h.

◆ GetProcessName()

const char * TRestEventRateAnalysisProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 67 of file TRestEventRateAnalysisProcess.h.

◆ Initialize()

void TRestEventRateAnalysisProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 112 of file TRestEventRateAnalysisProcess.cxx.

◆ InitProcess()

void TRestEventRateAnalysisProcess::InitProcess ( )
overridevirtual

Process initialization.

Reimplemented from TRestEventProcess.

Definition at line 126 of file TRestEventRateAnalysisProcess.cxx.

◆ PrintMetadata()

void TRestEventRateAnalysisProcess::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 55 of file TRestEventRateAnalysisProcess.h.

◆ ProcessEvent()

TRestEvent * TRestEventRateAnalysisProcess::ProcessEvent ( TRestEvent * inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 140 of file TRestEventRateAnalysisProcess.cxx.

Field Documentation

◆ fEvent

TRestEvent* TRestEventRateAnalysisProcess::fEvent
private

A pointer to the input event.

Definition at line 32 of file TRestEventRateAnalysisProcess.h.

◆ fFirstEventTime

Double_t TRestEventRateAnalysisProcess::fFirstEventTime
private

It registers the timestamp from the first event to calculate time from start observables.

Definition at line 35 of file TRestEventRateAnalysisProcess.h.

◆ fPreviousEventTime

std::vector<Double_t> TRestEventRateAnalysisProcess::fPreviousEventTime
private

It keeps a historic list of timestamps of the previous N events. Now fixed to N=10 events.

Definition at line 38 of file TRestEventRateAnalysisProcess.h.

◆ fRateAnalysis

bool TRestEventRateAnalysisProcess::fRateAnalysis = false
private

It indicates whether to add rate observables which is correct only under single thread run.

Definition at line 41 of file TRestEventRateAnalysisProcess.h.


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