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

Detailed Description

An analysis process helping to assign tags to user defined ranges of signal ids.

Process to identify events from different DAQ id ranges. For example, it might be used to identify different detectors, modules or regions of the detectors that are read with a common acquisition setup.

This process was motivated by the TREX-DM experiment, where we have a readout with two independent readout planes. This process will allow to identify events happening at any of those two planes in an early data processing stage, where we do not have yet access to the TRestDetectorReadout description.

In the particular case of TREX-DM, we define two readout planes as a function of the daq id range as follows:

This process allows to define a tag associated to given id range. Each tag contains the user given name and the associated range of ids.

Metadata parameters that can be defined inside the <tag definition:

Any number of daq ID ranges can be defined (e.g. as many "tag" sections as needed).

Example in rml file:

<addProcess type="TRestRawSignalIdTaggingProcess" name="TREXsides" value="ON" observable="all" >
<tag name="South" ids="(0,575)"/>
<tag name="North" ids="(576,1151)"/>
</addProcess>

Each tag is associated with an integer number, from 1 upwards, in the order found inside the tag list. First tag being associated to 1, second tag to 2, etc. This will be used to construct an observable helping to identify the tags it belongs to.

Observables

Same parameters as in TRestRawSignalAnalisysProcess to identify good signals:

If any of these parameters is missing all signals will be taken into account to identify the ID range.

Cuts

This process implements TRestEventProcess::ApplyCut, therefore, we might apply a selection of events to get only those events that belong to a given definition.

To keep only "South" events for further data processing we would do:

<cut name="tagId" value="(1,1)" />

To keep only those events producing events on both detectors we could do:

<cut name="tagId" value="(10,20)" />

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2022-September: First implementation of TRestRawSignalIdTaggingProcess Created from TRestRawSignalAnalysisProcess

Author
David Díez Ibáñez

Definition at line 31 of file TRestRawSignalIdTaggingProcess.h.

#include <TRestRawSignalIdTaggingProcess.h>

Inheritance diagram for TRestRawSignalIdTaggingProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRawSignalIdTaggingProcess, 3)
 
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
 Process initialization. More...
 
void PrintMetadata () override
 Implemented it in the derived metadata class to print out specific metadata information. More...
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 The main processing event function. More...
 
 TRestRawSignalIdTaggingProcess ()
 Default constructor. More...
 
 ~TRestRawSignalIdTaggingProcess ()
 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 InitFromConfigFile () override
 Process initialization. More...
 
void Initialize () override
 Function to initialize input/output event members and define the section name. More...
 

Private Attributes

TVector2 fBaseLineRange = TVector2(-1, -1)
 The range where the baseline range will be calculated. More...
 
bool fGoodSignalsOnly = false
 
std::vector< TVector2 > fIdRanges
 A list containing the id range for each tag. More...
 
Int_t fPointsOverThreshold = -1
 The minimum number of points over threshold to identify a signal as such. More...
 
Double_t fPointThreshold = -1
 The number of sigmas over baseline fluctuations to identify a point overthreshold. More...
 
TRestRawSignalEventfSignalEvent
 A pointer to the specific TRestRawSignalEvent input. More...
 
Double_t fSignalThreshold = -1
 A parameter to define a minimum signal fluctuation. Measured in sigmas. More...
 
std::vector< std::string > fTagNames
 A list containing the tag names for each signal ids range. 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

◆ TRestRawSignalIdTaggingProcess()

TRestRawSignalIdTaggingProcess::TRestRawSignalIdTaggingProcess ( )

Default constructor.

Definition at line 124 of file TRestRawSignalIdTaggingProcess.cxx.

◆ ~TRestRawSignalIdTaggingProcess()

TRestRawSignalIdTaggingProcess::~TRestRawSignalIdTaggingProcess ( )

Default destructor.

Definition at line 129 of file TRestRawSignalIdTaggingProcess.cxx.

Member Function Documentation

◆ GetInputEvent()

RESTValue TRestRawSignalIdTaggingProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 67 of file TRestRawSignalIdTaggingProcess.h.

◆ GetOutputEvent()

RESTValue TRestRawSignalIdTaggingProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 68 of file TRestRawSignalIdTaggingProcess.h.

◆ GetProcessName()

const char * TRestRawSignalIdTaggingProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 94 of file TRestRawSignalIdTaggingProcess.h.

◆ InitFromConfigFile()

void TRestRawSignalIdTaggingProcess::InitFromConfigFile ( )
overrideprivatevirtual

Process initialization.

Reimplemented from TRestEventProcess.

Definition at line 150 of file TRestRawSignalIdTaggingProcess.cxx.

◆ Initialize()

void TRestRawSignalIdTaggingProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 135 of file TRestRawSignalIdTaggingProcess.cxx.

◆ InitProcess()

void TRestRawSignalIdTaggingProcess::InitProcess ( )
overridevirtual

Process initialization.

Reimplemented from TRestEventProcess.

Definition at line 145 of file TRestRawSignalIdTaggingProcess.cxx.

◆ PrintMetadata()

void TRestRawSignalIdTaggingProcess::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 73 of file TRestRawSignalIdTaggingProcess.h.

◆ ProcessEvent()

TRestEvent * TRestRawSignalIdTaggingProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 178 of file TRestRawSignalIdTaggingProcess.cxx.

Field Documentation

◆ fBaseLineRange

TVector2 TRestRawSignalIdTaggingProcess::fBaseLineRange = TVector2(-1, -1)
private

The range where the baseline range will be calculated.

Definition at line 45 of file TRestRawSignalIdTaggingProcess.h.

◆ fGoodSignalsOnly

bool TRestRawSignalIdTaggingProcess::fGoodSignalsOnly = false
private

Properly initialized GoodSignals parameters (fBaseLineRange, fPointThreshold, fSignalThreshold, fPointsOverThreshold)

Definition at line 58 of file TRestRawSignalIdTaggingProcess.h.

◆ fIdRanges

std::vector<TVector2> TRestRawSignalIdTaggingProcess::fIdRanges
private

A list containing the id range for each tag.

Definition at line 40 of file TRestRawSignalIdTaggingProcess.h.

◆ fPointsOverThreshold

Int_t TRestRawSignalIdTaggingProcess::fPointsOverThreshold = -1
private

The minimum number of points over threshold to identify a signal as such.

Definition at line 54 of file TRestRawSignalIdTaggingProcess.h.

◆ fPointThreshold

Double_t TRestRawSignalIdTaggingProcess::fPointThreshold = -1
private

The number of sigmas over baseline fluctuations to identify a point overthreshold.

Definition at line 48 of file TRestRawSignalIdTaggingProcess.h.

◆ fSignalEvent

TRestRawSignalEvent* TRestRawSignalIdTaggingProcess::fSignalEvent
private

A pointer to the specific TRestRawSignalEvent input.

Definition at line 34 of file TRestRawSignalIdTaggingProcess.h.

◆ fSignalThreshold

Double_t TRestRawSignalIdTaggingProcess::fSignalThreshold = -1
private

A parameter to define a minimum signal fluctuation. Measured in sigmas.

Definition at line 51 of file TRestRawSignalIdTaggingProcess.h.

◆ fTagNames

std::vector<std::string> TRestRawSignalIdTaggingProcess::fTagNames
private

A list containing the tag names for each signal ids range.

Definition at line 37 of file TRestRawSignalIdTaggingProcess.h.


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