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

Detailed Description

A process to convolute the input raw signal event with a given input response.

The TRestRawSignalShapingProcess allows to convolute a given time signal response with the TRestRawSignal input signals found inside the input TRestRawSignalEvent. This process may serve for conditioning the signals produced in a MonteCarlo simulation and emulate those from real electronics.

For the moment, only gaussian response has been implemented.

The different parameters allowed in this process are:


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-March: First implementation Xinglong

2018-March: Transfered to TRestRawSignal Javier Galan

Author
Xinglong
Javier Galan

Definition at line 32 of file TRestRawSignalShapingProcess.h.

#include <TRestRawSignalShapingProcess.h>

Inheritance diagram for TRestRawSignalShapingProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRawSignalShapingProcess, 2)
 
void EndProcess () override
 Function to include required actions after all events have been processed. 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...
 
Double_t GetShapingGain () const
 
Double_t GetShapingTime () const
 
TString GetShapingType () const
 
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="")
 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 *inputEvent) override
 The main processing event function. More...
 
void SetShapingGain (Double_t shapingGain)
 
void SetShapingTime (Double_t shapingTime)
 
void SetShapingType (const TString &samplingType)
 
 TRestRawSignalShapingProcess ()
 Default constructor. More...
 
 TRestRawSignalShapingProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestRawSignalShapingProcess ()
 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

TString fResponseFilename
 
Double_t fShapingGain = 1.0
 A value used to scale the input signal. More...
 
Double_t fShapingTime = 10.0
 The characteristic time of the shaping. More...
 
TString fShapingType = "shaperSin"
 Types are : gaus, shaper, shaperSin, responseFile. 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

TRestRawSignalEventfInputSignalEvent
 A pointer to the specific TRestRawSignalEvent input. More...
 
TRestRawSignalEventfOutputSignalEvent
 A pointer to the specific TRestRawSignalEvent output. 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

◆ TRestRawSignalShapingProcess() [1/2]

TRestRawSignalShapingProcess::TRestRawSignalShapingProcess ( )

Default constructor.

Definition at line 95 of file src/TRestRawSignalShapingProcess.cxx.

◆ TRestRawSignalShapingProcess() [2/2]

TRestRawSignalShapingProcess::TRestRawSignalShapingProcess ( 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 109 of file src/TRestRawSignalShapingProcess.cxx.

◆ ~TRestRawSignalShapingProcess()

TRestRawSignalShapingProcess::~TRestRawSignalShapingProcess ( )

Default destructor.

Definition at line 117 of file src/TRestRawSignalShapingProcess.cxx.

Member Function Documentation

◆ EndProcess()

void TRestRawSignalShapingProcess::EndProcess ( )
overridevirtual

Function to include required actions after all events have been processed.

Reimplemented from TRestEventProcess.

Definition at line 287 of file src/TRestRawSignalShapingProcess.cxx.

◆ GetInputEvent()

RESTValue TRestRawSignalShapingProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 63 of file TRestRawSignalShapingProcess.h.

◆ GetOutputEvent()

RESTValue TRestRawSignalShapingProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 64 of file TRestRawSignalShapingProcess.h.

◆ GetProcessName()

const char * TRestRawSignalShapingProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 90 of file TRestRawSignalShapingProcess.h.

◆ GetShapingGain()

Double_t TRestRawSignalShapingProcess::GetShapingGain ( ) const
inline

Definition at line 60 of file TRestRawSignalShapingProcess.h.

◆ GetShapingTime()

Double_t TRestRawSignalShapingProcess::GetShapingTime ( ) const
inline

Definition at line 57 of file TRestRawSignalShapingProcess.h.

◆ GetShapingType()

TString TRestRawSignalShapingProcess::GetShapingType ( ) const
inline

Definition at line 54 of file TRestRawSignalShapingProcess.h.

◆ Initialize()

void TRestRawSignalShapingProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 123 of file src/TRestRawSignalShapingProcess.cxx.

◆ InitProcess()

void TRestRawSignalShapingProcess::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 152 of file src/TRestRawSignalShapingProcess.cxx.

◆ LoadConfig()

void TRestRawSignalShapingProcess::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 143 of file src/TRestRawSignalShapingProcess.cxx.

◆ Maker()

TRestEventProcess * TRestRawSignalShapingProcess::Maker ( )
inline

Returns a new instance of this class.

Definition at line 87 of file TRestRawSignalShapingProcess.h.

◆ PrintMetadata()

void TRestRawSignalShapingProcess::PrintMetadata ( )
inlineoverridevirtual

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

Reimplemented from TRestMetadata.

Definition at line 73 of file TRestRawSignalShapingProcess.h.

◆ ProcessEvent()

TRestEvent * TRestRawSignalShapingProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

This is done for every event however we could do it inside InitProcess! It is the response function. Does not change from event ot event

Implements TRestEventProcess.

Definition at line 192 of file src/TRestRawSignalShapingProcess.cxx.

◆ SetShapingGain()

void TRestRawSignalShapingProcess::SetShapingGain ( Double_t  shapingGain)
inline

Definition at line 61 of file TRestRawSignalShapingProcess.h.

◆ SetShapingTime()

void TRestRawSignalShapingProcess::SetShapingTime ( Double_t  shapingTime)
inline

Definition at line 58 of file TRestRawSignalShapingProcess.h.

◆ SetShapingType()

void TRestRawSignalShapingProcess::SetShapingType ( const TString &  samplingType)
inline

Definition at line 55 of file TRestRawSignalShapingProcess.h.

Field Documentation

◆ fInputSignalEvent

TRestRawSignalEvent* TRestRawSignalShapingProcess::fInputSignalEvent
private

A pointer to the specific TRestRawSignalEvent input.

Definition at line 35 of file TRestRawSignalShapingProcess.h.

◆ fOutputSignalEvent

TRestRawSignalEvent* TRestRawSignalShapingProcess::fOutputSignalEvent
private

A pointer to the specific TRestRawSignalEvent output.

Definition at line 38 of file TRestRawSignalShapingProcess.h.

◆ fResponseFilename

TString TRestRawSignalShapingProcess::fResponseFilename
protected

Definition at line 44 of file TRestRawSignalShapingProcess.h.

◆ fShapingGain

Double_t TRestRawSignalShapingProcess::fShapingGain = 1.0
protected

A value used to scale the input signal.

Definition at line 51 of file TRestRawSignalShapingProcess.h.

◆ fShapingTime

Double_t TRestRawSignalShapingProcess::fShapingTime = 10.0
protected

The characteristic time of the shaping.

Definition at line 49 of file TRestRawSignalShapingProcess.h.

◆ fShapingType

TString TRestRawSignalShapingProcess::fShapingType = "shaperSin"
protected

Types are : gaus, shaper, shaperSin, responseFile.

Definition at line 47 of file TRestRawSignalShapingProcess.h.


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