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

Detailed Description

A pure analysis process to generate histograms with detector channels activity.

The TRestDetectorSignalChannelActivityProcess allows to generate different histograms in order to monitor the number of times a channel has observed a signal given a set of conditions on the threshold and number of active channels.

TRestDetectorSignalChannelActivityProcess produces different channel activity histograms involving signals. These histograms thus show the activity of the channels after zero suppression.

The following list describes the different histograms that are generated:

The number of channels and their numbering can be specified by the user to match the detector being used.


RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2017-February: First implementation of signal channel activity process. Javier Galan

Author
Javier Galan

Definition at line 33 of file TRestDetectorSignalChannelActivityProcess.h.

#include <TRestDetectorSignalChannelActivityProcess.h>

Inheritance diagram for TRestDetectorSignalChannelActivityProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestDetectorSignalChannelActivityProcess, 3)
 
void EndProcess () override
 Function to include required actions after all events have been processed. In this process it will take care of writing the histograms to disk. More...
 
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 InitProcess () override
 Process initialization. The ROOT TH1 histograms are created here using the limits defined in the process metadata members. 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
 It prints out the process parameters stored in the metadata structure. More...
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 The main processing event function. More...
 
 TRestDetectorSignalChannelActivityProcess ()
 Default constructor. More...
 
 TRestDetectorSignalChannelActivityProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestDetectorSignalChannelActivityProcess ()
 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

TH1D * fDaqChannelsHisto
 The daq channels histogram. More...
 
Int_t fDaqEndChannel
 The last channel at the daq channels histogram. More...
 
Int_t fDaqHistogramChannels
 The number of bins at the daq channels histogram. More...
 
Int_t fDaqStartChannel
 The first channel at the daq channels histogram. More...
 
Double_t fHighThreshold
 The value of the higher signal threshold to add it to the histogram. More...
 
Double_t fLowThreshold
 The value of the lower signal threshold to add it to the histogram. More...
 
TH1D * fReadoutChannelsHisto
 The readout channels histogram. More...
 
TH1D * fReadoutChannelsHisto_MultiSignals
 The readout channels histogram built more than 3-signal events (low threshold) More...
 
TH1D * fReadoutChannelsHisto_MultiSignals_High
 The readout channels histogram built more than 3-signal events (high threshold) More...
 
TH1D * fReadoutChannelsHisto_OneSignal
 The readout channels histogram built with 1-signal events (low threshold) More...
 
TH1D * fReadoutChannelsHisto_OneSignal_High
 The readout channels histogram built with 1-signal events (high threshold) More...
 
TH1D * fReadoutChannelsHisto_ThreeSignals
 The readout channels histogram built with 3-signal events (low threshold) More...
 
TH1D * fReadoutChannelsHisto_ThreeSignals_High
 The readout channels histogram built with 3-signal events (high threshold) More...
 
TH1D * fReadoutChannelsHisto_TwoSignals
 The readout channels histogram built with 2-signal events (low threshold) More...
 
TH1D * fReadoutChannelsHisto_TwoSignals_High
 The readout channels histogram built with 2-signal events (high threshold) More...
 
Int_t fReadoutEndChannel
 The last channel at the readout channels histogram. More...
 
Int_t fReadoutHistogramChannels
 The number of bins at the readout channels histogram. More...
 
Int_t fReadoutStartChannel
 The first channel at the readout channels histogram. 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 InitFromConfigFile () override
 Function to read input parameters from the RML TRestDetectorSignalChannelActivityProcess metadata section. More...
 
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

TRestDetectorReadoutfReadout
 A pointer to the readout metadata information accessible to TRestRun. More...
 
TRestDetectorSignalEventfSignalEvent
 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

◆ TRestDetectorSignalChannelActivityProcess() [1/2]

TRestDetectorSignalChannelActivityProcess::TRestDetectorSignalChannelActivityProcess ( )

Default constructor.

Definition at line 88 of file TRestDetectorSignalChannelActivityProcess.cxx.

◆ TRestDetectorSignalChannelActivityProcess() [2/2]

TRestDetectorSignalChannelActivityProcess::TRestDetectorSignalChannelActivityProcess ( 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 102 of file TRestDetectorSignalChannelActivityProcess.cxx.

◆ ~TRestDetectorSignalChannelActivityProcess()

TRestDetectorSignalChannelActivityProcess::~TRestDetectorSignalChannelActivityProcess ( )

Default destructor.

Definition at line 112 of file TRestDetectorSignalChannelActivityProcess.cxx.

Member Function Documentation

◆ EndProcess()

void TRestDetectorSignalChannelActivityProcess::EndProcess ( )
overridevirtual

Function to include required actions after all events have been processed. In this process it will take care of writing the histograms to disk.

Reimplemented from TRestEventProcess.

Definition at line 268 of file TRestDetectorSignalChannelActivityProcess.cxx.

◆ GetInputEvent()

RESTValue TRestDetectorSignalChannelActivityProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 103 of file TRestDetectorSignalChannelActivityProcess.h.

◆ GetOutputEvent()

RESTValue TRestDetectorSignalChannelActivityProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 104 of file TRestDetectorSignalChannelActivityProcess.h.

◆ GetProcessName()

const char * TRestDetectorSignalChannelActivityProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 131 of file TRestDetectorSignalChannelActivityProcess.h.

◆ InitFromConfigFile()

void TRestDetectorSignalChannelActivityProcess::InitFromConfigFile ( )
overrideprivatevirtual

Function to read input parameters from the RML TRestDetectorSignalChannelActivityProcess metadata section.

Reimplemented from TRestEventProcess.

Definition at line 291 of file TRestDetectorSignalChannelActivityProcess.cxx.

◆ Initialize()

void TRestDetectorSignalChannelActivityProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 125 of file TRestDetectorSignalChannelActivityProcess.cxx.

◆ InitProcess()

void TRestDetectorSignalChannelActivityProcess::InitProcess ( )
overridevirtual

Process initialization. The ROOT TH1 histograms are created here using the limits defined in the process metadata members.

The readout histograms will only be created in case an appropiate readout definition is found in the processing chain.

Reimplemented from TRestEventProcess.

Definition at line 155 of file TRestDetectorSignalChannelActivityProcess.cxx.

◆ LoadConfig()

void TRestDetectorSignalChannelActivityProcess::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 144 of file TRestDetectorSignalChannelActivityProcess.cxx.

◆ LoadDefaultConfig()

void TRestDetectorSignalChannelActivityProcess::LoadDefaultConfig ( )
private

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

Definition at line 119 of file TRestDetectorSignalChannelActivityProcess.cxx.

◆ PrintMetadata()

void TRestDetectorSignalChannelActivityProcess::PrintMetadata ( )
inlineoverridevirtual

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

Reimplemented from TRestMetadata.

Definition at line 113 of file TRestDetectorSignalChannelActivityProcess.h.

◆ ProcessEvent()

TRestEvent * TRestDetectorSignalChannelActivityProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Copying the signal event to the output event

Implements TRestEventProcess.

Definition at line 201 of file TRestDetectorSignalChannelActivityProcess.cxx.

Field Documentation

◆ fDaqChannelsHisto

TH1D* TRestDetectorSignalChannelActivityProcess::fDaqChannelsHisto
protected

The daq channels histogram.

Definition at line 73 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fDaqEndChannel

Int_t TRestDetectorSignalChannelActivityProcess::fDaqEndChannel
protected

The last channel at the daq channels histogram.

Definition at line 64 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fDaqHistogramChannels

Int_t TRestDetectorSignalChannelActivityProcess::fDaqHistogramChannels
protected

The number of bins at the daq channels histogram.

Definition at line 55 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fDaqStartChannel

Int_t TRestDetectorSignalChannelActivityProcess::fDaqStartChannel
protected

The first channel at the daq channels histogram.

Definition at line 61 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fHighThreshold

Double_t TRestDetectorSignalChannelActivityProcess::fHighThreshold
protected

The value of the higher signal threshold to add it to the histogram.

Definition at line 52 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fLowThreshold

Double_t TRestDetectorSignalChannelActivityProcess::fLowThreshold
protected

The value of the lower signal threshold to add it to the histogram.

Definition at line 49 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fReadout

TRestDetectorReadout* TRestDetectorSignalChannelActivityProcess::fReadout
private

A pointer to the readout metadata information accessible to TRestRun.

Definition at line 39 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fReadoutChannelsHisto

TH1D* TRestDetectorSignalChannelActivityProcess::fReadoutChannelsHisto
protected

The readout channels histogram.

Definition at line 76 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fReadoutChannelsHisto_MultiSignals

TH1D* TRestDetectorSignalChannelActivityProcess::fReadoutChannelsHisto_MultiSignals
protected

The readout channels histogram built more than 3-signal events (low threshold)

Definition at line 97 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fReadoutChannelsHisto_MultiSignals_High

TH1D* TRestDetectorSignalChannelActivityProcess::fReadoutChannelsHisto_MultiSignals_High
protected

The readout channels histogram built more than 3-signal events (high threshold)

Definition at line 100 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fReadoutChannelsHisto_OneSignal

TH1D* TRestDetectorSignalChannelActivityProcess::fReadoutChannelsHisto_OneSignal
protected

The readout channels histogram built with 1-signal events (low threshold)

Definition at line 79 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fReadoutChannelsHisto_OneSignal_High

TH1D* TRestDetectorSignalChannelActivityProcess::fReadoutChannelsHisto_OneSignal_High
protected

The readout channels histogram built with 1-signal events (high threshold)

Definition at line 82 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fReadoutChannelsHisto_ThreeSignals

TH1D* TRestDetectorSignalChannelActivityProcess::fReadoutChannelsHisto_ThreeSignals
protected

The readout channels histogram built with 3-signal events (low threshold)

Definition at line 91 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fReadoutChannelsHisto_ThreeSignals_High

TH1D* TRestDetectorSignalChannelActivityProcess::fReadoutChannelsHisto_ThreeSignals_High
protected

The readout channels histogram built with 3-signal events (high threshold)

Definition at line 94 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fReadoutChannelsHisto_TwoSignals

TH1D* TRestDetectorSignalChannelActivityProcess::fReadoutChannelsHisto_TwoSignals
protected

The readout channels histogram built with 2-signal events (low threshold)

Definition at line 85 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fReadoutChannelsHisto_TwoSignals_High

TH1D* TRestDetectorSignalChannelActivityProcess::fReadoutChannelsHisto_TwoSignals_High
protected

The readout channels histogram built with 2-signal events (high threshold)

Definition at line 88 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fReadoutEndChannel

Int_t TRestDetectorSignalChannelActivityProcess::fReadoutEndChannel
protected

The last channel at the readout channels histogram.

Definition at line 70 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fReadoutHistogramChannels

Int_t TRestDetectorSignalChannelActivityProcess::fReadoutHistogramChannels
protected

The number of bins at the readout channels histogram.

Definition at line 58 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fReadoutStartChannel

Int_t TRestDetectorSignalChannelActivityProcess::fReadoutStartChannel
protected

The first channel at the readout channels histogram.

Definition at line 67 of file TRestDetectorSignalChannelActivityProcess.h.

◆ fSignalEvent

TRestDetectorSignalEvent* TRestDetectorSignalChannelActivityProcess::fSignalEvent
private

A pointer to the specific TRestDetectorSignalEvent input.

Definition at line 36 of file TRestDetectorSignalChannelActivityProcess.h.


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