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

Detailed Description

A process allowing to recover selected channels from a TRestRawSignalEvent.

The TRestDetectorSignalRecoveryProcess allows to recover a selection of daq channel ids from a TRestDetectorSignalEvent. The dead channels must be known beforehand and the signal ids to be recovered must be specified through the corresponding section at the RML configuration file.

The following example will apply the recovery algorithm for the channels with signal ids 17,19,27 and 67. The signal ids must exist in the readout defined through the TRestDetectorReadout structure.

<TRestDetectorSignalRecoveryProcess name="returnChannels"
title="Recovering few channels" verboseLevel="debug" >
<parameter name="channelIds" value="{17,27,67}" />
A process allowing to recover selected channels from a TRestRawSignalEvent.

The dead channel reconstruction algorithm is for the moment very simple. The charge of the dead channel is directly calculated by using the charge of the adjacent readout channels, $s_i = 0.5 \times (s_{i-1} + s_{i+1})$

Now we preserve the energy of the event, we apply the following correction to the dead channel (i) and the adjacent channels.

$s_{i-1} = 0.5 * s_{i-1}$ $s_i = 0.5 \times (s_{i-1} + s_{i+1})$ $s_{i+1} = 0.5 * s_{i+1}$ The algorithm will also identify in case we have up to two consecutive dead channels. In that case it will apply the following correction, where i and i+1 are the dead channels.

$s_{i-1} = 0.5 * s_{i-1}$ $s_i = 1/6 \times (2*s_{i-1} + s_{i+2})$ $s_{i+1} = 1/6 \times (s_{i-1} + 2*s_{i+2})$ $s_{i+2} = 0.5 * s_{i+2}$

This process will access the information of the decoding stored in the TRestDetectorReadout definition to assure that the righ signal ids, corresponding to the adjacent channels, are used in the calculation.

Warning
This process will only be functional if the detectorlib was compiled. You may check if it is the case executing the command rest-config --libs, and checking the output shows -lRestDetector.

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2017-November: First implementation of TRestDetectorSignalRecoveryProcess. Originally it was TRestRawSignalRecoveryProcess. Javier Galan

2023-February: Update of the process so that it preserves energy and takes into account two consecutive dead channels. Ana Quintana/Javier Galan

2023-March: Update of the process fixing some problems of the previous update that had some errors related to the time in the function IncreaseAmplitude Ana Quintana

Author
Javier Galan
Ana Quintana

Definition at line 32 of file TRestDetectorSignalRecoveryProcess.h.

#include <TRestDetectorSignalRecoveryProcess.h>

Inheritance diagram for TRestDetectorSignalRecoveryProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestDetectorSignalRecoveryProcess, 1)
 
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
 Function to initialize the process. TRestDetectorSignalRecoveryProcess requires to get a pointer to TRestDetectorReadout. More...
 
void LoadConfig (const std::string &configFilename, const std::string &name="")
 Function to load the configuration from an external configuration file. 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 *eventInput) override
 The main processing event function. More...
 
 TRestDetectorSignalRecoveryProcess ()
 Default constructor. More...
 
 TRestDetectorSignalRecoveryProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestDetectorSignalRecoveryProcess ()
 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 ()
 

Private Member Functions

int GetAdjacentSignalIds (Int_t signalId, Int_t &idLeft, Int_t &idRight)
 It returns the channel daq id of the adjacent readout channels. It will properly identify that we got two dead channels, but no more than two. 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

std::vector< Int_t > fChannelIds
 
TRestDetectorSignalEventfInputSignalEvent
 A pointer to the specific TRestDetectorSignalEvent input. More...
 
TRestDetectorSignalEventfOutputSignalEvent
 A pointer to the specific TRestDetectorSignalEvent input. More...
 
TRestDetectorReadoutfReadout
 A pointer to the readout that will be extracted from TRestRun. 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...
 
- 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...
 

Constructor & Destructor Documentation

◆ TRestDetectorSignalRecoveryProcess() [1/2]

TRestDetectorSignalRecoveryProcess::TRestDetectorSignalRecoveryProcess ( )

Default constructor.

Definition at line 103 of file TRestDetectorSignalRecoveryProcess.cxx.

◆ TRestDetectorSignalRecoveryProcess() [2/2]

TRestDetectorSignalRecoveryProcess::TRestDetectorSignalRecoveryProcess ( 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 117 of file TRestDetectorSignalRecoveryProcess.cxx.

◆ ~TRestDetectorSignalRecoveryProcess()

TRestDetectorSignalRecoveryProcess::~TRestDetectorSignalRecoveryProcess ( )

Default destructor.

Definition at line 128 of file TRestDetectorSignalRecoveryProcess.cxx.

Member Function Documentation

◆ GetAdjacentSignalIds()

int TRestDetectorSignalRecoveryProcess::GetAdjacentSignalIds ( Int_t  signalId,
Int_t &  idLeft,
Int_t &  idRight 
)
private

It returns the channel daq id of the adjacent readout channels. It will properly identify that we got two dead channels, but no more than two.

It returns a value that determines the case we are considering.

0: Something went wrong (channels not found?) 1: There is only one dead channel 2: There is an additional dead channel to the left 3: There is an additional dead channel to the right

Definition at line 287 of file TRestDetectorSignalRecoveryProcess.cxx.

◆ GetInputEvent()

RESTValue TRestDetectorSignalRecoveryProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 52 of file TRestDetectorSignalRecoveryProcess.h.

◆ GetOutputEvent()

RESTValue TRestDetectorSignalRecoveryProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 53 of file TRestDetectorSignalRecoveryProcess.h.

◆ GetProcessName()

const char * TRestDetectorSignalRecoveryProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 73 of file TRestDetectorSignalRecoveryProcess.h.

◆ Initialize()

void TRestDetectorSignalRecoveryProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 142 of file TRestDetectorSignalRecoveryProcess.cxx.

◆ InitProcess()

void TRestDetectorSignalRecoveryProcess::InitProcess ( )
overridevirtual

Function to initialize the process. TRestDetectorSignalRecoveryProcess requires to get a pointer to TRestDetectorReadout.

Reimplemented from TRestEventProcess.

Definition at line 171 of file TRestDetectorSignalRecoveryProcess.cxx.

◆ LoadConfig()

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

Definition at line 162 of file TRestDetectorSignalRecoveryProcess.cxx.

◆ LoadDefaultConfig()

void TRestDetectorSignalRecoveryProcess::LoadDefaultConfig ( )
private

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

Definition at line 133 of file TRestDetectorSignalRecoveryProcess.cxx.

◆ Maker()

TRestEventProcess * TRestDetectorSignalRecoveryProcess::Maker ( )
inline

Returns a new instance of this class.

Definition at line 70 of file TRestDetectorSignalRecoveryProcess.h.

◆ PrintMetadata()

void TRestDetectorSignalRecoveryProcess::PrintMetadata ( )
inlineoverridevirtual

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

Reimplemented from TRestMetadata.

Definition at line 61 of file TRestDetectorSignalRecoveryProcess.h.

◆ ProcessEvent()

TRestEvent * TRestDetectorSignalRecoveryProcess::ProcessEvent ( TRestEvent eventInput)
overridevirtual

The main processing event function.

If the dead channel has no charge on left and right then we do not correct. We could think about correction here? It means it is the first or last channel.

Energy preserved. This could be optional using a new metadata member

Energy preserved. This could be optional using a new metadata member

We removed the charge that we place at the dead channel In this case we remove a 25% because we will enter twice in this loop

Implements TRestEventProcess.

Definition at line 183 of file TRestDetectorSignalRecoveryProcess.cxx.

Field Documentation

◆ fChannelIds

std::vector<Int_t> TRestDetectorSignalRecoveryProcess::fChannelIds
private

Definition at line 34 of file TRestDetectorSignalRecoveryProcess.h.

◆ fInputSignalEvent

TRestDetectorSignalEvent* TRestDetectorSignalRecoveryProcess::fInputSignalEvent
private

A pointer to the specific TRestDetectorSignalEvent input.

Definition at line 37 of file TRestDetectorSignalRecoveryProcess.h.

◆ fOutputSignalEvent

TRestDetectorSignalEvent* TRestDetectorSignalRecoveryProcess::fOutputSignalEvent
private

A pointer to the specific TRestDetectorSignalEvent input.

Definition at line 40 of file TRestDetectorSignalRecoveryProcess.h.

◆ fReadout

TRestDetectorReadout* TRestDetectorSignalRecoveryProcess::fReadout
private

A pointer to the readout that will be extracted from TRestRun.

Definition at line 43 of file TRestDetectorSignalRecoveryProcess.h.


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