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

Detailed Description

Definition at line 13 of file TRestRawPeaksFinderProcess.h.

Inheritance diagram for TRestRawPeaksFinderProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRawPeaksFinderProcess, 3)
 
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 InitFromConfigFile () override
 To make settings from rml file. This method must be implemented in the derived class. More...
 
void InitProcess () override
 To be executed at the beginning of the run (outside event loop) More...
 
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...
 
 TRestRawPeaksFinderProcess (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 ()
 

Private Attributes

TVector2 fBaselineRange = {0, 10}
 range of samples to calculate baseline for peak finding More...
 
std::set< std::string > fChannelTypes = {}
 
UShort_t fDistance = 10
 distance between two peaks to consider them as different More...
 
TRestRawReadoutMetadatafReadoutMetadata = nullptr
 
TRestRawSignalEventfSignalEvent = nullptr
 
Double_t fThresholdOverBaseline = 2.0
 threshold over baseline to consider a peak More...
 
UShort_t fWindow = 10
 window size to calculate the peak amplitude 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

◆ TRestRawPeaksFinderProcess()

TRestRawPeaksFinderProcess::TRestRawPeaksFinderProcess ( const char *  configFilename)
inlineexplicit

Definition at line 41 of file TRestRawPeaksFinderProcess.h.

Member Function Documentation

◆ EndProcess()

void TRestRawPeaksFinderProcess::EndProcess ( )
inlineoverridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 37 of file TRestRawPeaksFinderProcess.h.

◆ GetInputEvent()

RESTValue TRestRawPeaksFinderProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 30 of file TRestRawPeaksFinderProcess.h.

◆ GetOutputEvent()

RESTValue TRestRawPeaksFinderProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 31 of file TRestRawPeaksFinderProcess.h.

◆ GetProcessName()

const char * TRestRawPeaksFinderProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 39 of file TRestRawPeaksFinderProcess.h.

◆ InitFromConfigFile()

void TRestRawPeaksFinderProcess::InitFromConfigFile ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 139 of file TRestRawPeaksFinderProcess.cxx.

◆ InitProcess()

void TRestRawPeaksFinderProcess::InitProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 10 of file TRestRawPeaksFinderProcess.cxx.

◆ PrintMetadata()

void TRestRawPeaksFinderProcess::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 175 of file TRestRawPeaksFinderProcess.cxx.

◆ ProcessEvent()

TRestEvent * TRestRawPeaksFinderProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

Process one event.

Implements TRestEventProcess.

Definition at line 12 of file TRestRawPeaksFinderProcess.cxx.

Field Documentation

◆ fBaselineRange

TVector2 TRestRawPeaksFinderProcess::fBaselineRange = {0, 10}
private

range of samples to calculate baseline for peak finding

Definition at line 21 of file TRestRawPeaksFinderProcess.h.

◆ fChannelTypes

std::set<std::string> TRestRawPeaksFinderProcess::fChannelTypes = {}
private

Definition at line 27 of file TRestRawPeaksFinderProcess.h.

◆ fDistance

UShort_t TRestRawPeaksFinderProcess::fDistance = 10
private

distance between two peaks to consider them as different

Definition at line 23 of file TRestRawPeaksFinderProcess.h.

◆ fReadoutMetadata

TRestRawReadoutMetadata* TRestRawPeaksFinderProcess::fReadoutMetadata = nullptr
private

Definition at line 16 of file TRestRawPeaksFinderProcess.h.

◆ fSignalEvent

TRestRawSignalEvent* TRestRawPeaksFinderProcess::fSignalEvent = nullptr
private

Definition at line 15 of file TRestRawPeaksFinderProcess.h.

◆ fThresholdOverBaseline

Double_t TRestRawPeaksFinderProcess::fThresholdOverBaseline = 2.0
private

threshold over baseline to consider a peak

Definition at line 19 of file TRestRawPeaksFinderProcess.h.

◆ fWindow

UShort_t TRestRawPeaksFinderProcess::fWindow = 10
private

window size to calculate the peak amplitude

Definition at line 25 of file TRestRawPeaksFinderProcess.h.


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