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

Detailed Description

An analysis process to extract valuable information from a TRestRawSignalEvent.

THIS DOCUMENTATION NEEDS REVISION. TODO If possible a figure with the pulse ilustrating the different observables extracted.

The following metadata parameters might be defined at the RML to control the rawsignal analysis is performed:

There are 3 additional parameters that are used in combination to identify the points over threshold at each signal. Those parameters are used, for example, to calculate the number of good signals observable.

Additionaly, there is a metadata parameter,signalsRange that allows to define the signal ids over which this process will have effect. This parameter may allow to define different TRestRawSignalAnalysisProcess instances at the RML operating over different signal ranges. For example:

<TRestRawSignalAnalysisProcess name="rawMM" signalsRange="(0,512)"
baseLineRange="(5,100)" observables="all" />
<TRestRawSignalAnalysisProcess name="rawVETO" signalsRange="(513,1024)" >
<parameter name="pointThreshold" value="5" />
<parameter name="signalThreshold" value="3.5" />
<parameter name="pointsOverThreshold" value="15" />
<observable name="rawAna_max_amplitude_map" type="map<int,double>" />
An analysis process to extract valuable information from a TRestRawSignalEvent.

Observables

Number of signals and base line:

Integrals and energy estimations:

Time observables:

Peak amplitude observables:

Peak time observables:

Observables for individual signal info:

You may add filters to any observable inside the analysis tree. To add a cut, write "cut" sections in your rml file:

<cut name="MeanBaseLineCut" value="(0,4096)" />

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 will 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:

2017-February: First implementation of raw signal analysis process into REST_v2. Created from TRestDetectorSignalAnalysisProcess

Author
Javier Galan

Definition at line 31 of file TRestRawSignalAnalysisProcess.h.

#include <TRestRawSignalAnalysisProcess.h>

Inheritance diagram for TRestRawSignalAnalysisProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRawSignalAnalysisProcess, 5)
 
RESTValue GetInputEvent () const override
 Get pointer to input event. Must be implemented in the derived class.
 
RESTValue GetOutputEvent () const override
 Get pointer to output event. Must be implemented in the derived class.
 
const char * GetProcessName () const override
 
void InitFromConfigFile () override
 To make settings from rml file. This method must be implemented in the derived class.
 
void InitProcess () override
 Process initialization.
 
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...
 
 TRestRawSignalAnalysisProcess ()
 Default constructor.
 
 ~TRestRawSignalAnalysisProcess ()
 Default destructor.
 
- 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()
 
 ClassDefOverride (TRestEventProcess, 3)
 
virtual void EndOfEventProcess (TRestEvent *inputEvent=nullptr)
 End of event process. Nothing to do. Called directly after ProcessEvent()
 
virtual void EndProcess ()
 To be executed at the end of the run (outside event loop)
 
TRestAnalysisTreeGetAnalysisTree () const
 Return the local analysis tree (dummy)
 
TCanvas * GetCanvas () const
 Get canvas.
 
TRestAnalysisTreeGetFullAnalysisTree ()
 
std::vector< std::string > GetListOfAddedObservables ()
 
TRestRunGetRunInfo () const
 Return the pointer of the hosting TRestRun object.
 
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.
 
Bool_t isExternal () const
 Return whether this process is external process.
 
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.
 
virtual Bool_t OpenInputFiles (const std::vector< std::string > &files)
 
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.
 
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.
 
Bool_t singleThreadOnly () const
 Return whether this process is single std::thread only.
 
 TRestEventProcess ()
 
 ~TRestEventProcess ()
 

Private Member Functions

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

Private Attributes

std::string fBaseLineOption
 Option for calculation of baseline parameters, can be set to "ROBUST".
 
TVector2 fBaseLineRange = TVector2(5, 55)
 The range where the baseline range will be calculated.
 
std::string fChannelType
 avoid error when loading parameters (not used)
 
std::set< std::string > fChannelTypes = {}
 
TVector2 fIntegralRange = TVector2(10, 500)
 The range where the observables will be calculated.
 
Int_t fPointsOverThreshold = 5
 The minimum number of points over threshold to identify a signal as such.
 
Double_t fPointThreshold = 2
 The number of sigmas over baseline fluctuations to identify a point over threshold.
 
Bool_t fRangeEnabled = false
 Just a flag to quickly determine if we have to apply the range filter.
 
TRestRawReadoutMetadatafReadoutMetadata = nullptr
 
TRestRawSignalEventfSignalEvent
 A pointer to the specific TRestRawSignalEvent input.
 
TVector2 fSignalsRange = TVector2(-1, -1)
 It defines the signals id range where analysis is applied.
 
Double_t fSignalThreshold = 5
 A parameter to define a minimum signal fluctuation. Measured in sigmas.
 

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.
 
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
 
TVector2 fCanvasSize
 Canvas size.
 
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.
 
bool fIsExternal = false
 It defines if the process reads event data from an external source.
 
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.
 
bool fReadOnly = false
 not used, keep for compatibility
 
TRestRunfRunInfo = nullptr
 < Pointer to TRestRun object where to find metadata.
 
bool fSingleThreadOnly = false
 
bool fValidateObservables = false
 It defines if observable names should be added to the validation list.
 

Member Function Documentation

◆ PrintMetadata()

void TRestRawSignalAnalysisProcess::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 83 of file TRestRawSignalAnalysisProcess.h.

◆ ProcessEvent()

TRestEvent * TRestRawSignalAnalysisProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

We define (or re-define) the baseline range and calculation range of our raw-signals.

Important call we need to initialize the points over threshold in a TRestRawSignal

Implements TRestEventProcess.

Definition at line 296 of file TRestRawSignalAnalysisProcess.cxx.


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