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

Detailed Description




         RESTSoft : Software for Rare Event Searches with TPCs

         TRestDetectorSingleChannelAnalysisProcess.h

Definition at line 24 of file TRestDetectorSingleChannelAnalysisProcess.h.

#include <TRestDetectorSingleChannelAnalysisProcess.h>

Inheritance diagram for TRestDetectorSingleChannelAnalysisProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestDetectorSingleChannelAnalysisProcess, 1)
 
void EndProcess () override
 To be executed at the end of the run (outside event loop) More...
 
void FitChannelGain ()
 
TH1D * GetChannelSpectrum (int id)
 
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 PrintChannelSpectrums (std::string filename)
 
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...
 
void SaveGainMetadata (std::string filename)
 
 TRestDetectorSingleChannelAnalysisProcess (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 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

bool fApplyGainCorrection
 
TRestDetectorGainMapfCalib
 
std::string fCalibSave
 
std::map< int, double > fChannelFitMean
 
std::map< int, double > fChannelGain
 
std::map< int, double > fChannelGainError
 
std::map< int, TH1D * > fChannelThrIntegral
 
bool fCreateGainMap
 
TVector2 fNGoodSignalsCutRange
 
TRestDetectorReadoutfReadout
 
TRestDetectorSignalEventfSignalEvent
 
TVector2 fSpecFitRange
 
TVector2 fThrIntegralCutRange
 

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

◆ TRestDetectorSingleChannelAnalysisProcess()

TRestDetectorSingleChannelAnalysisProcess::TRestDetectorSingleChannelAnalysisProcess ( )

◆ ~TRestDetectorSingleChannelAnalysisProcess()

TRestDetectorSingleChannelAnalysisProcess::~TRestDetectorSingleChannelAnalysisProcess ( )

Member Function Documentation

◆ EndProcess()

void TRestDetectorSingleChannelAnalysisProcess::EndProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 157 of file TRestDetectorSingleChannelAnalysisProcess.cxx.

◆ FitChannelGain()

void TRestDetectorSingleChannelAnalysisProcess::FitChannelGain ( )

◆ GetChannelSpectrum()

TH1D * TRestDetectorSingleChannelAnalysisProcess::GetChannelSpectrum ( int  id)

◆ GetInputEvent()

RESTValue TRestDetectorSingleChannelAnalysisProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 48 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ GetOutputEvent()

RESTValue TRestDetectorSingleChannelAnalysisProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 49 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ GetProcessName()

const char * TRestDetectorSingleChannelAnalysisProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 76 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ InitFromConfigFile()

void TRestDetectorSingleChannelAnalysisProcess::InitFromConfigFile ( )
overrideprivatevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 299 of file TRestDetectorSingleChannelAnalysisProcess.cxx.

◆ Initialize()

void TRestDetectorSingleChannelAnalysisProcess::Initialize ( )
overrideprivatevirtual

Making default settings.

Reimplemented from TRestMetadata.

Definition at line 35 of file TRestDetectorSingleChannelAnalysisProcess.cxx.

◆ InitProcess()

void TRestDetectorSingleChannelAnalysisProcess::InitProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 44 of file TRestDetectorSingleChannelAnalysisProcess.cxx.

◆ PrintChannelSpectrums()

void TRestDetectorSingleChannelAnalysisProcess::PrintChannelSpectrums ( std::string  filename)

◆ PrintMetadata()

void TRestDetectorSingleChannelAnalysisProcess::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 60 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ ProcessEvent()

TRestEvent * TRestDetectorSingleChannelAnalysisProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

Process one event.

Implements TRestEventProcess.

Definition at line 91 of file TRestDetectorSingleChannelAnalysisProcess.cxx.

◆ SaveGainMetadata()

void TRestDetectorSingleChannelAnalysisProcess::SaveGainMetadata ( std::string  filename)

Field Documentation

◆ fApplyGainCorrection

bool TRestDetectorSingleChannelAnalysisProcess::fApplyGainCorrection
private

Definition at line 34 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ fCalib

TRestDetectorGainMap* TRestDetectorSingleChannelAnalysisProcess::fCalib
private

Definition at line 28 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ fCalibSave

std::string TRestDetectorSingleChannelAnalysisProcess::fCalibSave
private

Definition at line 39 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ fChannelFitMean

std::map<int, double> TRestDetectorSingleChannelAnalysisProcess::fChannelFitMean
private

Definition at line 43 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ fChannelGain

std::map<int, double> TRestDetectorSingleChannelAnalysisProcess::fChannelGain
private

Definition at line 44 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ fChannelGainError

std::map<int, double> TRestDetectorSingleChannelAnalysisProcess::fChannelGainError
private

Definition at line 45 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ fChannelThrIntegral

std::map<int, TH1D*> TRestDetectorSingleChannelAnalysisProcess::fChannelThrIntegral
private

Definition at line 42 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ fCreateGainMap

bool TRestDetectorSingleChannelAnalysisProcess::fCreateGainMap
private

Definition at line 35 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ fNGoodSignalsCutRange

TVector2 TRestDetectorSingleChannelAnalysisProcess::fNGoodSignalsCutRange
private

Definition at line 37 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ fReadout

TRestDetectorReadout* TRestDetectorSingleChannelAnalysisProcess::fReadout
private

Definition at line 27 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ fSignalEvent

TRestDetectorSignalEvent* TRestDetectorSingleChannelAnalysisProcess::fSignalEvent
private

Definition at line 26 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ fSpecFitRange

TVector2 TRestDetectorSingleChannelAnalysisProcess::fSpecFitRange
private

Definition at line 38 of file TRestDetectorSingleChannelAnalysisProcess.h.

◆ fThrIntegralCutRange

TVector2 TRestDetectorSingleChannelAnalysisProcess::fThrIntegralCutRange
private

Definition at line 36 of file TRestDetectorSingleChannelAnalysisProcess.h.


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