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

Detailed Description

A process to transform a daq channel and physical time to spatial coordinates.

TRestDetectorSignalToHitsProcess will use the readout definition to transform a TRestDetectorSignalEvent into a TRestDetectorHitsEvent. The physical time on the input event will be associated with a physical spatial Z-coordinate using the gas drift velocity given by the user as the metadata parameter "driftVelocity". If the drift velocity is not specified by the user, or it is negative, the process will try to retrieve the drift velocity from the TRestDetectorGas metadata definition that should have been defined, and therefore available to the TRestRun instance. In the case that the drift velocity is retrieved from TRestDetectorGas two more parameters become relevant, the detector pressure, and the drift field, that play a role on the value of the drift velocity.

Therefore, relevant parameters (see also the process header) are:

On top of that, this process will need to get access to a TRestDetectorReadout definition in order to transform the corresponding signal id found at each signal in TRestDetectorSignalEvent to a spatial physical position in the XY plane. The readout plane position at TRestDetectorReadout definition is also used as a reference to obtain the final Z-coordinate in this process.

Note
Therefore, the real absolute Z of the event will only be connected to reality if the physical time given at the TRestDetectorSignalEvent corresponds with the drift time to the readout plane. This is usually not the case, since our electronics system does not know the interaction time. Although, this might be the case if the interaction light is measured using a PMT, or the results are coming from Monte Carlo simulated data.

In order to transform the points found at each TRestSignal inside a TRestDetectorSignalEvent, there are different methods that might lead to different results. Those are defined at the "method" metadata parameter. If this parameter is not given, its default value will be "tripleMax".

The possible values for the "method" metadata parameter are:

The following figure shows the results of applying the process to a Monte Carlo artificially signal generated, where the energy deposits are exactly at their corresponding physical drift time values. No shaping or any other electronic effects were included at the input event (left figure). The drift time is translated to a Z-coordinate on the output event, where we show only one readout projection in X (right figure).


RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2016-January: First concept and implementation.

Author
Javier Galan

2022-January: Implementing new method intwindod

Author
JuanAn Garcia

Definition at line 34 of file TRestDetectorSignalToHitsProcess.h.

#include <TRestDetectorSignalToHitsProcess.h>

Inheritance diagram for TRestDetectorSignalToHitsProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestDetectorSignalToHitsProcess, 4)
 
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. Observable names are interpreted and auxiliar observable members, related to VolumeEdep, MeanPos, TracksCounter, TrackEDep observables defined in TRestGeant4AnalysisProcess are filled at this stage. More...
 
void LoadConfig (const std::string &configFilename, const std::string &name="")
 
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...
 
 TRestDetectorSignalToHitsProcess ()
 Default constructor. More...
 
 TRestDetectorSignalToHitsProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestDetectorSignalToHitsProcess () override
 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

Double_t fDriftVelocity = -1
 The drift velocity in standard REST units (mm/us). More...
 
Double_t fElectricField = -1
 The electric field in standard REST units (V/mm). Only relevant if TRestDetectorGas is used. More...
 
Double_t fGasPressure = -1
 The gas pressure in atm. Only relevant if TRestDetectorGas is used. More...
 
Double_t fIntWindow = 5
 
TString fMethod = "tripleMaxAverage"
 The method used to transform the signal points to hits. More...
 
Double_t fThreshold = 100.
 
- 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

TRestDetectorGasfGas
 A pointer to the detector gas definition accessible to TRestRun. More...
 
TRestDetectorHitsEventfHitsEvent
 A pointer to the specific TRestDetectorHitsEvent output. More...
 
TRestDetectorReadoutfReadout
 A pointer to the detector readout definition accessible to TRestRun. More...
 
TRestDetectorSignalEventfSignalEvent
 A pointer to the specific TRestDetectorHitsEvent 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

◆ TRestDetectorSignalToHitsProcess() [1/2]

TRestDetectorSignalToHitsProcess::TRestDetectorSignalToHitsProcess ( )

Default constructor.

Definition at line 137 of file TRestDetectorSignalToHitsProcess.cxx.

◆ TRestDetectorSignalToHitsProcess() [2/2]

TRestDetectorSignalToHitsProcess::TRestDetectorSignalToHitsProcess ( 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 151 of file TRestDetectorSignalToHitsProcess.cxx.

◆ ~TRestDetectorSignalToHitsProcess()

TRestDetectorSignalToHitsProcess::~TRestDetectorSignalToHitsProcess ( )
override

Default destructor.

Definition at line 167 of file TRestDetectorSignalToHitsProcess.cxx.

Member Function Documentation

◆ GetInputEvent()

RESTValue TRestDetectorSignalToHitsProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 72 of file TRestDetectorSignalToHitsProcess.h.

◆ GetOutputEvent()

RESTValue TRestDetectorSignalToHitsProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 73 of file TRestDetectorSignalToHitsProcess.h.

◆ GetProcessName()

const char * TRestDetectorSignalToHitsProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 97 of file TRestDetectorSignalToHitsProcess.h.

◆ Initialize()

void TRestDetectorSignalToHitsProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 173 of file TRestDetectorSignalToHitsProcess.cxx.

◆ InitProcess()

void TRestDetectorSignalToHitsProcess::InitProcess ( )
overridevirtual

Process initialization. Observable names are interpreted and auxiliar observable members, related to VolumeEdep, MeanPos, TracksCounter, TrackEDep observables defined in TRestGeant4AnalysisProcess are filled at this stage.

Reimplemented from TRestEventProcess.

Definition at line 189 of file TRestDetectorSignalToHitsProcess.cxx.

◆ LoadDefaultConfig()

void TRestDetectorSignalToHitsProcess::LoadDefaultConfig ( )
private

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

Definition at line 162 of file TRestDetectorSignalToHitsProcess.cxx.

◆ PrintMetadata()

void TRestDetectorSignalToHitsProcess::PrintMetadata ( )
inlineoverridevirtual

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

Reimplemented from TRestMetadata.

Definition at line 81 of file TRestDetectorSignalToHitsProcess.h.

◆ ProcessEvent()

TRestEvent * TRestDetectorSignalToHitsProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 236 of file TRestDetectorSignalToHitsProcess.cxx.

Field Documentation

◆ fDriftVelocity

Double_t TRestDetectorSignalToHitsProcess::fDriftVelocity = -1
protected

The drift velocity in standard REST units (mm/us).

Definition at line 60 of file TRestDetectorSignalToHitsProcess.h.

◆ fElectricField

Double_t TRestDetectorSignalToHitsProcess::fElectricField = -1
protected

The electric field in standard REST units (V/mm). Only relevant if TRestDetectorGas is used.

Definition at line 54 of file TRestDetectorSignalToHitsProcess.h.

◆ fGas

TRestDetectorGas* TRestDetectorSignalToHitsProcess::fGas
private

A pointer to the detector gas definition accessible to TRestRun.

Definition at line 46 of file TRestDetectorSignalToHitsProcess.h.

◆ fGasPressure

Double_t TRestDetectorSignalToHitsProcess::fGasPressure = -1
protected

The gas pressure in atm. Only relevant if TRestDetectorGas is used.

Definition at line 57 of file TRestDetectorSignalToHitsProcess.h.

◆ fHitsEvent

TRestDetectorHitsEvent* TRestDetectorSignalToHitsProcess::fHitsEvent
private

A pointer to the specific TRestDetectorHitsEvent output.

Definition at line 37 of file TRestDetectorSignalToHitsProcess.h.

◆ fIntWindow

Double_t TRestDetectorSignalToHitsProcess::fIntWindow = 5
protected

Definition at line 66 of file TRestDetectorSignalToHitsProcess.h.

◆ fMethod

TString TRestDetectorSignalToHitsProcess::fMethod = "tripleMaxAverage"
protected

The method used to transform the signal points to hits.

Definition at line 63 of file TRestDetectorSignalToHitsProcess.h.

◆ fReadout

TRestDetectorReadout* TRestDetectorSignalToHitsProcess::fReadout
private

A pointer to the detector readout definition accessible to TRestRun.

Definition at line 43 of file TRestDetectorSignalToHitsProcess.h.

◆ fSignalEvent

TRestDetectorSignalEvent* TRestDetectorSignalToHitsProcess::fSignalEvent
private

A pointer to the specific TRestDetectorHitsEvent input.

Definition at line 40 of file TRestDetectorSignalToHitsProcess.h.

◆ fThreshold

Double_t TRestDetectorSignalToHitsProcess::fThreshold = 100.
protected

Definition at line 69 of file TRestDetectorSignalToHitsProcess.h.


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