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

Detailed Description

A process to generate integral observables for signal ADC windows found above the defined energy threshold.

This process will receive as input a physical time signal, then it will use a fixed time window defined by the sampling time in us, and the the sampling depth. It will scan the physical signal using the virtual ADC defined window, and if the total energy integral inside the window is above the threshold it will define a non-zero value for the corresponding integral observable.

This process was one day used to optimize the efficiency of NLDBD events when registering events in a fixed-size time window, at a given energy window threshold. It must be noted that it may happen that the event extension is larger than the chosen window size.

Therefore, when when we define an observable for a given energy threshold, i.e. Integral_Eth2, for 2keV energy threshold, we are in fact determining the first moving ADC window where the accumulative integral on that window is above 2keV.

The resulting observable integral will be more deeply connected with the electronics response, since the physical event could be extended in a wider physical time window.

We need to define manually the values for the threshold inside the integral observable:

// It will define a trigger window when the accumulative integral
// gets above 10keV.
<observable name="Integral_Eth10" type="double" value="ON" />
A process to generate integral observables for signal ADC windows found above the defined energy thre...

This process is very similar to TRestDetectorSignalToRawSignalProcess. Altrhought, this process is just a pure analysis process producing few observables without touching the event, while the later is used as a transformation process used to produce a raw signal event type with the possibility of using a threshold definition.


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-April: First implementation of trigger analysis process Javier Galan

Author
Javier Galan

Definition at line 31 of file TRestDetectorTriggerAnalysisProcess.h.

#include <TRestDetectorTriggerAnalysisProcess.h>

Inheritance diagram for TRestDetectorTriggerAnalysisProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestDetectorTriggerAnalysisProcess, 2)
 
RESTValue GetInputEvent () const override
 Returns a pointer to the input signal event. More...
 
RESTValue GetOutputEvent () const override
 Returns a pointer to the input signal event. More...
 
const char * GetProcessName () const override
 Returns a std::string with the process name. More...
 
void InitProcess () override
 Process initialization. Observable names are interpreted here. More...
 
void LoadConfig (const std::string &configFilename, const std::string &name="")
 Function to load the configuration from an external configuration file. More...
 
void PrintMetadata () override
 Prints on screen the metadata information registered by this process. More...
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 The main processing event function. More...
 
 TRestDetectorTriggerAnalysisProcess ()
 Default constructor. More...
 
 TRestDetectorTriggerAnalysisProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestDetectorTriggerAnalysisProcess ()
 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

Int_t fADCLength = 512
 It defines the number of bins used to define the sampling depth. More...
 
Double_t fSampling = 0.2
 It defines the sampling time in us to treat the signal as if it would be a rawsignal. 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...
 

Private Member Functions

void Initialize () override
 Function to initialize input/output event members and define the section name. More...
 
void LoadDefaultConfig ()
 Function to load the default config in absence of RML input. More...
 

Private Attributes

std::vector< std::string > fIntegralObservables
 A std::vector to temporary store the name of threshold observables. More...
 
TRestDetectorSignalEventfSignalEvent
 A pointer to the specific TRestSignalEvent input. More...
 
std::vector< double > fThreshold
 A std::vector to temporary the extracted threshold value from the corresponding observable. 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

◆ TRestDetectorTriggerAnalysisProcess() [1/2]

TRestDetectorTriggerAnalysisProcess::TRestDetectorTriggerAnalysisProcess ( )

Default constructor.

Definition at line 97 of file TRestDetectorTriggerAnalysisProcess.cxx.

◆ TRestDetectorTriggerAnalysisProcess() [2/2]

TRestDetectorTriggerAnalysisProcess::TRestDetectorTriggerAnalysisProcess ( const char *  configFilename)

Constructor loading data from a config file.

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

The default behaviour is that the config file must be specified with full path, absolute or relative.

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

Definition at line 111 of file TRestDetectorTriggerAnalysisProcess.cxx.

◆ ~TRestDetectorTriggerAnalysisProcess()

TRestDetectorTriggerAnalysisProcess::~TRestDetectorTriggerAnalysisProcess ( )

Default destructor.

Definition at line 119 of file TRestDetectorTriggerAnalysisProcess.cxx.

Member Function Documentation

◆ GetInputEvent()

RESTValue TRestDetectorTriggerAnalysisProcess::GetInputEvent ( ) const
inlineoverridevirtual

Returns a pointer to the input signal event.

Implements TRestEventProcess.

Definition at line 55 of file TRestDetectorTriggerAnalysisProcess.h.

◆ GetOutputEvent()

RESTValue TRestDetectorTriggerAnalysisProcess::GetOutputEvent ( ) const
inlineoverridevirtual

Returns a pointer to the input signal event.

Implements TRestEventProcess.

Definition at line 58 of file TRestDetectorTriggerAnalysisProcess.h.

◆ GetProcessName()

const char * TRestDetectorTriggerAnalysisProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns a std::string with the process name.

Implements TRestEventProcess.

Definition at line 76 of file TRestDetectorTriggerAnalysisProcess.h.

◆ Initialize()

void TRestDetectorTriggerAnalysisProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 130 of file TRestDetectorTriggerAnalysisProcess.cxx.

◆ InitProcess()

void TRestDetectorTriggerAnalysisProcess::InitProcess ( )
overridevirtual

Process initialization. Observable names are interpreted here.

Reimplemented from TRestEventProcess.

Definition at line 156 of file TRestDetectorTriggerAnalysisProcess.cxx.

◆ LoadConfig()

void TRestDetectorTriggerAnalysisProcess::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 TRestGeant4AnalysisProcess section inside the RML.

Definition at line 149 of file TRestDetectorTriggerAnalysisProcess.cxx.

◆ LoadDefaultConfig()

void TRestDetectorTriggerAnalysisProcess::LoadDefaultConfig ( )
private

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

Definition at line 124 of file TRestDetectorTriggerAnalysisProcess.cxx.

◆ PrintMetadata()

void TRestDetectorTriggerAnalysisProcess::PrintMetadata ( )
inlineoverridevirtual

Prints on screen the metadata information registered by this process.

Reimplemented from TRestMetadata.

Definition at line 66 of file TRestDetectorTriggerAnalysisProcess.h.

◆ ProcessEvent()

TRestEvent * TRestDetectorTriggerAnalysisProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 173 of file TRestDetectorTriggerAnalysisProcess.cxx.

Field Documentation

◆ fADCLength

Int_t TRestDetectorTriggerAnalysisProcess::fADCLength = 512
protected

It defines the number of bins used to define the sampling depth.

Definition at line 51 of file TRestDetectorTriggerAnalysisProcess.h.

◆ fIntegralObservables

std::vector<std::string> TRestDetectorTriggerAnalysisProcess::fIntegralObservables
private

A std::vector to temporary store the name of threshold observables.

Definition at line 37 of file TRestDetectorTriggerAnalysisProcess.h.

◆ fSampling

Double_t TRestDetectorTriggerAnalysisProcess::fSampling = 0.2
protected

It defines the sampling time in us to treat the signal as if it would be a rawsignal.

Definition at line 48 of file TRestDetectorTriggerAnalysisProcess.h.

◆ fSignalEvent

TRestDetectorSignalEvent* TRestDetectorTriggerAnalysisProcess::fSignalEvent
private

A pointer to the specific TRestSignalEvent input.

Definition at line 34 of file TRestDetectorTriggerAnalysisProcess.h.

◆ fThreshold

std::vector<double> TRestDetectorTriggerAnalysisProcess::fThreshold
private

A std::vector to temporary the extracted threshold value from the corresponding observable.

Definition at line 40 of file TRestDetectorTriggerAnalysisProcess.h.


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