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

Detailed Description

A pure analysis process to generate histograms with detector channels activity

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

TRestRawSignalChannelActivityProcess produces different channel activity
histograms involving raw signals. These histograms thus show the activity
of the channels before zero suppression, which can be useful to perform
noise studies.

The following list describes the different histograms that are generated:

* **daqChannelActivityRaw**: Histogram based on the DAQ channels.
The following figure shows the DAQ channel activity histogram for raw
signals in:
    * a) the case where all the channels are saved (where a flat
         distribution is seen because all channels have the same raw
         activity)
    * b) the case where only channels that have been hit are saved.

\htmlonly <style>div.image img[src="daqChActRaw.png"]{width:1000px;}</style>

///

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


Warning
⚠ REST is under continuous 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:

2020-August: First implementation of raw signal channel activity process. Cristina Margalejo

Author
Cristina Margalejo

Definition at line 33 of file TRestRawSignalChannelActivityProcess.h.

#include <TRestRawSignalChannelActivityProcess.h>

Inheritance diagram for TRestRawSignalChannelActivityProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRawSignalChannelActivityProcess, 6)
 
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 PrintMetadata () override
 It prints out the process parameters stored in the metadata structure. More...
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 The main processing event function. More...
 
 TRestRawSignalChannelActivityProcess ()
 Default constructor. More...
 
 ~TRestRawSignalChannelActivityProcess ()
 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 fDaqChannels = 300
 The number of bins at the daq channels histogram. More...
 
TH1D * fDaqChannelsHisto = nullptr
 The daq channels histogram. More...
 
Int_t fDaqEndChannel = 4620
 The last channel at the daq channels histogram. More...
 
Int_t fDaqStartChannel = 4320
 The first channel at the daq 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 Initialize () override
 Function to initialize input/output event members and define the section name. More...
 

Private Attributes

std::string fChannelType
 
TRestRawSignalEventfInputEvent = nullptr
 A pointer to the specific TRestRawSignalEvent input. More...
 
TRestRawReadoutMetadatafReadoutMetadata = nullptr
 

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

◆ TRestRawSignalChannelActivityProcess()

TRestRawSignalChannelActivityProcess::TRestRawSignalChannelActivityProcess ( )

Default constructor.

Definition at line 108 of file TRestRawSignalChannelActivityProcess.cxx.

◆ ~TRestRawSignalChannelActivityProcess()

TRestRawSignalChannelActivityProcess::~TRestRawSignalChannelActivityProcess ( )

Default destructor.

Definition at line 113 of file TRestRawSignalChannelActivityProcess.cxx.

Member Function Documentation

◆ EndProcess()

void TRestRawSignalChannelActivityProcess::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 194 of file TRestRawSignalChannelActivityProcess.cxx.

◆ GetInputEvent()

RESTValue TRestRawSignalChannelActivityProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 57 of file TRestRawSignalChannelActivityProcess.h.

◆ GetOutputEvent()

RESTValue TRestRawSignalChannelActivityProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 58 of file TRestRawSignalChannelActivityProcess.h.

◆ GetProcessName()

const char * TRestRawSignalChannelActivityProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 80 of file TRestRawSignalChannelActivityProcess.h.

◆ Initialize()

void TRestRawSignalChannelActivityProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 119 of file TRestRawSignalChannelActivityProcess.cxx.

◆ InitProcess()

void TRestRawSignalChannelActivityProcess::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 appropriate readout definition is found in the processing chain.

Reimplemented from TRestEventProcess.

Definition at line 135 of file TRestRawSignalChannelActivityProcess.cxx.

◆ PrintMetadata()

void TRestRawSignalChannelActivityProcess::PrintMetadata ( )
inlineoverridevirtual

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

Reimplemented from TRestMetadata.

Definition at line 65 of file TRestRawSignalChannelActivityProcess.h.

◆ ProcessEvent()

TRestEvent * TRestRawSignalChannelActivityProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 149 of file TRestRawSignalChannelActivityProcess.cxx.

Field Documentation

◆ fChannelType

std::string TRestRawSignalChannelActivityProcess::fChannelType
private

Definition at line 51 of file TRestRawSignalChannelActivityProcess.h.

◆ fDaqChannels

Int_t TRestRawSignalChannelActivityProcess::fDaqChannels = 300
protected

The number of bins at the daq channels histogram.

Definition at line 36 of file TRestRawSignalChannelActivityProcess.h.

◆ fDaqChannelsHisto

TH1D* TRestRawSignalChannelActivityProcess::fDaqChannelsHisto = nullptr
protected

The daq channels histogram.

Definition at line 45 of file TRestRawSignalChannelActivityProcess.h.

◆ fDaqEndChannel

Int_t TRestRawSignalChannelActivityProcess::fDaqEndChannel = 4620
protected

The last channel at the daq channels histogram.

Definition at line 42 of file TRestRawSignalChannelActivityProcess.h.

◆ fDaqStartChannel

Int_t TRestRawSignalChannelActivityProcess::fDaqStartChannel = 4320
protected

The first channel at the daq channels histogram.

Definition at line 39 of file TRestRawSignalChannelActivityProcess.h.

◆ fInputEvent

TRestRawSignalEvent* TRestRawSignalChannelActivityProcess::fInputEvent = nullptr
private

A pointer to the specific TRestRawSignalEvent input.

Definition at line 49 of file TRestRawSignalChannelActivityProcess.h.

◆ fReadoutMetadata

TRestRawReadoutMetadata* TRestRawSignalChannelActivityProcess::fReadoutMetadata = nullptr
private

Definition at line 52 of file TRestRawSignalChannelActivityProcess.h.


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