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

Detailed Description

A process to define and store quality numbers.

TRestDataQualityProcess ... TODO documentation here ...

A code example here

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2020-May: First implementation and concept Javier Galan Oscar Perez

Author
Javier Galan
Oscar Perez

Definition at line 30 of file TRestDataQualityProcess.h.

#include <TRestDataQualityProcess.h>

Inheritance diagram for TRestDataQualityProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestDataQualityProcess, 1)
 
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
 Returns the name of this process. More...
 
void LoadConfig (const std::string &configFilename, const std::string &name="")
 Function to load the configuration from an external configuration file. More...
 
TRestEventProcessMaker ()
 Returns a new instance of this class. More...
 
void PrintMetadata () override
 It prints out the process parameters stored in the metadata structure. More...
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 The main processing event function. More...
 
 TRestDataQualityProcess ()
 Default constructor. More...
 
 TRestDataQualityProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestDataQualityProcess ()
 Default destructor. More...
 
- 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 DisableBit (UInt_t &number, Int_t bitPosition)
 It sets to 0 the bit of number at position bitPosition More...
 
void EnableBit (UInt_t &number, Int_t bitPosition)
 It sets to 1 the bit of number at position bitPosition More...
 
void EndProcess () override
 Function to use when all events have been processed. More...
 
Bool_t EvaluateMetadataRule (TString value, TVector2 range)
 
void InitFromConfigFile () override
 Function reading input parameters from the RML TRestDataQualityProcess section. More...
 
void Initialize () override
 Function to initialize input/output event members and define the section name and library version. More...
 
void InitProcess () override
 Function to use in initialization of process members before starting to process the event. More...
 
Bool_t isBitEnabled (UInt_t number, Int_t bitPosition)
 
void LoadDefaultConfig ()
 Function to load the default config in absence of RML input. More...
 

Private Attributes

TRestEventfEvent = nullptr
 
std::vector< UInt_t > fQualityNumber
 A std::vector of custom quality numbers. More...
 
std::vector< TString > fQualityTag
 A std::vector of tag names for each quality number. More...
 
std::vector< TRestDataQualityRulesfRules
 A std::vector with the rule definitions for each quality number. 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

◆ TRestDataQualityProcess() [1/2]

TRestDataQualityProcess::TRestDataQualityProcess ( )

Default constructor.

Definition at line 56 of file TRestDataQualityProcess.cxx.

◆ TRestDataQualityProcess() [2/2]

TRestDataQualityProcess::TRestDataQualityProcess ( const char *  configFilename)

Constructor loading data from a config file.

The path to the config file can be specified using full path, absolute or relative.

If the file is not found then REST will try to find the file on the default paths defined in REST Framework, usually at the REST_PATH installation directory. Additional search paths may be defined using the parameter searchPath in globals section. See TRestMetadata description.

Parameters
configFilenameA const char* giving the path to an RML file.

Definition at line 72 of file TRestDataQualityProcess.cxx.

◆ ~TRestDataQualityProcess()

TRestDataQualityProcess::~TRestDataQualityProcess ( )

Default destructor.

Definition at line 81 of file TRestDataQualityProcess.cxx.

Member Function Documentation

◆ DisableBit()

void TRestDataQualityProcess::DisableBit ( UInt_t &  number,
Int_t  bitPosition 
)
inlineprivate

It sets to 0 the bit of number at position bitPosition

Definition at line 58 of file TRestDataQualityProcess.h.

◆ EnableBit()

void TRestDataQualityProcess::EnableBit ( UInt_t &  number,
Int_t  bitPosition 
)
inlineprivate

It sets to 1 the bit of number at position bitPosition

Definition at line 55 of file TRestDataQualityProcess.h.

◆ EndProcess()

void TRestDataQualityProcess::EndProcess ( )
overrideprivatevirtual

Function to use when all events have been processed.

We loop to each quality number definition

We loop to each rule from the quality definition

Reimplemented from TRestEventProcess.

Definition at line 136 of file TRestDataQualityProcess.cxx.

◆ EvaluateMetadataRule()

Bool_t TRestDataQualityProcess::EvaluateMetadataRule ( TString  value,
TVector2  range 
)
private

Definition at line 269 of file TRestDataQualityProcess.cxx.

◆ GetInputEvent()

RESTValue TRestDataQualityProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 64 of file TRestDataQualityProcess.h.

◆ GetOutputEvent()

RESTValue TRestDataQualityProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 65 of file TRestDataQualityProcess.h.

◆ GetProcessName()

const char * TRestDataQualityProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 77 of file TRestDataQualityProcess.h.

◆ InitFromConfigFile()

void TRestDataQualityProcess::InitFromConfigFile ( )
overrideprivatevirtual

Function reading input parameters from the RML TRestDataQualityProcess section.

Reimplemented from TRestEventProcess.

Definition at line 175 of file TRestDataQualityProcess.cxx.

◆ Initialize()

void TRestDataQualityProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 120 of file TRestDataQualityProcess.cxx.

◆ InitProcess()

void TRestDataQualityProcess::InitProcess ( )
overrideprivatevirtual

Function to use in initialization of process members before starting to process the event.

Reimplemented from TRestEventProcess.

Definition at line 111 of file TRestDataQualityProcess.cxx.

◆ isBitEnabled()

Bool_t TRestDataQualityProcess::isBitEnabled ( UInt_t  number,
Int_t  bitPosition 
)
inlineprivate

Definition at line 60 of file TRestDataQualityProcess.h.

◆ LoadConfig()

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

Function to load the configuration from an external configuration file.

If no configuration path is defined in TRestMetadata::SetConfigFilePath the path to the config file must be specified using full path, absolute or relative.

Parameters
configFilenameA const char* giving the path to an RML file.
nameThe name of the specific metadata. It will be used to find the corresponding TRestDataQualityProcess section inside the RML.

Definition at line 103 of file TRestDataQualityProcess.cxx.

◆ LoadDefaultConfig()

void TRestDataQualityProcess::LoadDefaultConfig ( )
private

Function to load the default config in absence of RML input.

Definition at line 86 of file TRestDataQualityProcess.cxx.

◆ Maker()

TRestEventProcess * TRestDataQualityProcess::Maker ( )
inline

Returns a new instance of this class.

Definition at line 74 of file TRestDataQualityProcess.h.

◆ PrintMetadata()

void TRestDataQualityProcess::PrintMetadata ( )
overridevirtual

It prints out the process parameters stored in the metadata structure.

Reimplemented from TRestMetadata.

Definition at line 233 of file TRestDataQualityProcess.cxx.

◆ ProcessEvent()

TRestEvent * TRestDataQualityProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 125 of file TRestDataQualityProcess.cxx.

Field Documentation

◆ fEvent

TRestEvent* TRestDataQualityProcess::fEvent = nullptr
private

Definition at line 41 of file TRestDataQualityProcess.h.

◆ fQualityNumber

std::vector<UInt_t> TRestDataQualityProcess::fQualityNumber
private

A std::vector of custom quality numbers.

Definition at line 33 of file TRestDataQualityProcess.h.

◆ fQualityTag

std::vector<TString> TRestDataQualityProcess::fQualityTag
private

A std::vector of tag names for each quality number.

Definition at line 36 of file TRestDataQualityProcess.h.

◆ fRules

std::vector<TRestDataQualityRules> TRestDataQualityProcess::fRules
private

A std::vector with the rule definitions for each quality number.

Definition at line 39 of file TRestDataQualityProcess.h.


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