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

Detailed Description

A process to convert a TRestRawSignalEvent into a TRestDetectorSignalEvent.

The TRestRawToDetectorSignalProcess transforms a TRestRawSignalEvent into a TRestDetectorSignalEvent. It applies a direct transform between both data types. The data points inside the raw signal are transformed to time information using the input sampling time and time start provided through the process RML section. A new method for zero suppression has been implemented, now it is capable to perform zero suppression as it was implemented int the TRestRawZeroSuppresionProcess, which identifies the points that are over threshold from the input TRestRawSignalEvent. The resulting points remains as a TRestRawSignalEvent.

All the data points will be transferred to the output signal event.

The following list describes the different parameters that can be used in this process.

List of observables:

The following lines of code show how the process metadata should be defined.

// A raw signal with 200ns binning will be translated to a
// TRestDetectorSignalEvent. The new signal will start at time=20us, and its
// amplitude will be reduced a factor 50. If zeroSuppression is true it will
// perform
<TRestRawToDetectorSignalProcess name="rsTos" title"Raw signal to signal">
<parameter name="sampling" value="0.2" units="us" />
<parameter name="triggerStarts" value="20" units="us" />
<parameter name="gain" value="1/50." />
<parameter name="zeroSuppression" value="true"/>
<parameter name="baseLineRange" value="(20,140)"/>
<parameter name="integralRange" value="(150,450)"/>
<parameter name="pointThreshold" value="3"/>
<parameter name="signalThreshold" value="7"/>
<parameter name="nPointsOverThreshold" value="7"/>
<observable name="NSignalsRejected" value="ON"/>
A process to convert a TRestRawSignalEvent into a TRestDetectorSignalEvent.

Warning
⚠ WARNING: REST is under continous 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 while 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:

2016-February: First implementation of rawsignal to signal conversion. Javier Gracia

2017-November: Class documented and re-furbished 2022-January: Added threshold parameter Javier Galan 2022-January: Adding ZeroSuppression method JuanAn Garcia

Author
Javier Gracia
Javier Galan

Definition at line 32 of file TRestRawToDetectorSignalProcess.h.

#include <TRestRawToDetectorSignalProcess.h>

Inheritance diagram for TRestRawToDetectorSignalProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRawToDetectorSignalProcess, 2)
 
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...
 
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...
 
 TRestRawToDetectorSignalProcess ()
 Default constructor. More...
 
void ZeroSuppresion (TRestRawSignal *rawSignal, TRestDetectorSignal &signal)
 
 ~TRestRawToDetectorSignalProcess ()
 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 ()
 

Protected Attributes

Bool_t fBaseLineCorrection = false
 A parameter to determine if baseline correction has been applied by a previous process. More...
 
TVector2 fBaseLineRange = TVector2(5, 55)
 The ADC range used for baseline offset definition. More...
 
Double_t fGain = 1
 A factor the data values will be multiplied by at the output signal. More...
 
TVector2 fIntegralRange = TVector2(10, 500)
 The ADC range used for integral definition and signal identification. More...
 
Int_t fNPointsOverThreshold = 5
 Number of consecutive points over threshold required to accept a signal. More...
 
Double_t fPointThreshold = 3
 Number of sigmas over baseline fluctuation to accept a point is over threshold. More...
 
Double_t fSampling = 0.1
 The sampling time used to transform the binned data to time information. More...
 
Double_t fSignalThreshold = 5
 A threshold parameter to accept or reject a pre-identified signal. See process description. More...
 
Double_t fThreshold = 0.1
 A factor the data values will be multiplied by at the output signal. More...
 
Double_t fTriggerStarts = 0
 The corresponding time of the first bin inside the raw signal. More...
 
Bool_t fZeroSuppression = false
 
- 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...
 

Private Member Functions

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

Private Attributes

TRestRawSignalEventfInputSignalEvent
 A pointer to the specific TRestRawSignalEvent input. More...
 
TRestDetectorSignalEventfOutputSignalEvent
 A pointer to the specific TRestDetectorSignalEvent input. 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...
 

Constructor & Destructor Documentation

◆ TRestRawToDetectorSignalProcess()

TRestRawToDetectorSignalProcess::TRestRawToDetectorSignalProcess ( )

Default constructor.

Definition at line 131 of file TRestRawToDetectorSignalProcess.cxx.

◆ ~TRestRawToDetectorSignalProcess()

TRestRawToDetectorSignalProcess::~TRestRawToDetectorSignalProcess ( )

Default destructor.

Definition at line 136 of file TRestRawToDetectorSignalProcess.cxx.

Member Function Documentation

◆ GetInputEvent()

RESTValue TRestRawToDetectorSignalProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 77 of file TRestRawToDetectorSignalProcess.h.

◆ GetOutputEvent()

RESTValue TRestRawToDetectorSignalProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 78 of file TRestRawToDetectorSignalProcess.h.

◆ GetProcessName()

const char * TRestRawToDetectorSignalProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 112 of file TRestRawToDetectorSignalProcess.h.

◆ Initialize()

void TRestRawToDetectorSignalProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 142 of file TRestRawToDetectorSignalProcess.cxx.

◆ Maker()

TRestEventProcess * TRestRawToDetectorSignalProcess::Maker ( )
inline

Returns a new instance of this class.

Definition at line 109 of file TRestRawToDetectorSignalProcess.h.

◆ PrintMetadata()

void TRestRawToDetectorSignalProcess::PrintMetadata ( )
inlineoverridevirtual

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

Reimplemented from TRestMetadata.

Definition at line 85 of file TRestRawToDetectorSignalProcess.h.

◆ ProcessEvent()

TRestEvent * TRestRawToDetectorSignalProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 153 of file TRestRawToDetectorSignalProcess.cxx.

◆ ZeroSuppresion()

void TRestRawToDetectorSignalProcess::ZeroSuppresion ( TRestRawSignal rawSignal,
TRestDetectorSignal signal 
)

Definition at line 194 of file TRestRawToDetectorSignalProcess.cxx.

Field Documentation

◆ fBaseLineCorrection

Bool_t TRestRawToDetectorSignalProcess::fBaseLineCorrection = false
protected

A parameter to determine if baseline correction has been applied by a previous process.

Definition at line 74 of file TRestRawToDetectorSignalProcess.h.

◆ fBaseLineRange

TVector2 TRestRawToDetectorSignalProcess::fBaseLineRange = TVector2(5, 55)
protected

The ADC range used for baseline offset definition.

Definition at line 59 of file TRestRawToDetectorSignalProcess.h.

◆ fGain

Double_t TRestRawToDetectorSignalProcess::fGain = 1
protected

A factor the data values will be multiplied by at the output signal.

Definition at line 50 of file TRestRawToDetectorSignalProcess.h.

◆ fInputSignalEvent

TRestRawSignalEvent* TRestRawToDetectorSignalProcess::fInputSignalEvent
private

A pointer to the specific TRestRawSignalEvent input.

Definition at line 35 of file TRestRawToDetectorSignalProcess.h.

◆ fIntegralRange

TVector2 TRestRawToDetectorSignalProcess::fIntegralRange = TVector2(10, 500)
protected

The ADC range used for integral definition and signal identification.

Definition at line 62 of file TRestRawToDetectorSignalProcess.h.

◆ fNPointsOverThreshold

Int_t TRestRawToDetectorSignalProcess::fNPointsOverThreshold = 5
protected

Number of consecutive points over threshold required to accept a signal.

Definition at line 71 of file TRestRawToDetectorSignalProcess.h.

◆ fOutputSignalEvent

TRestDetectorSignalEvent* TRestRawToDetectorSignalProcess::fOutputSignalEvent
private

A pointer to the specific TRestDetectorSignalEvent input.

Definition at line 38 of file TRestRawToDetectorSignalProcess.h.

◆ fPointThreshold

Double_t TRestRawToDetectorSignalProcess::fPointThreshold = 3
protected

Number of sigmas over baseline fluctuation to accept a point is over threshold.

Definition at line 65 of file TRestRawToDetectorSignalProcess.h.

◆ fSampling

Double_t TRestRawToDetectorSignalProcess::fSampling = 0.1
protected

The sampling time used to transform the binned data to time information.

Definition at line 44 of file TRestRawToDetectorSignalProcess.h.

◆ fSignalThreshold

Double_t TRestRawToDetectorSignalProcess::fSignalThreshold = 5
protected

A threshold parameter to accept or reject a pre-identified signal. See process description.

Definition at line 68 of file TRestRawToDetectorSignalProcess.h.

◆ fThreshold

Double_t TRestRawToDetectorSignalProcess::fThreshold = 0.1
protected

A factor the data values will be multiplied by at the output signal.

Definition at line 53 of file TRestRawToDetectorSignalProcess.h.

◆ fTriggerStarts

Double_t TRestRawToDetectorSignalProcess::fTriggerStarts = 0
protected

The corresponding time of the first bin inside the raw signal.

Definition at line 47 of file TRestRawToDetectorSignalProcess.h.

◆ fZeroSuppression

Bool_t TRestRawToDetectorSignalProcess::fZeroSuppression = false
protected

Definition at line 56 of file TRestRawToDetectorSignalProcess.h.


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