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

Detailed Description

A process to add/emulate electronic noise into a TRestRawSignalEvent.

TRestRawSignalAddNoiseProcess is a process that allows to add a random gaussian noise to the input TRestRawSignalEvent.

The process makes use of TRestRawSignal::GetWhiteNoiseSignal which simply adds a random gaussian value centered on zero and with a sigma given by the parameter noiseLevel.

The process can be defined as follows:

<parameter name="noiseLevel" value="10" />
A process to add/emulate electronic noise into a TRestRawSignalEvent.

or

<TRestRawSignalAddNoiseProcess name="noise" noiseLevel="10" />

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 will 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-February: First concept and implementation of TRestRawSignalAddNoise process.

Author
Javier Gracia

Definition at line 31 of file TRestRawSignalAddNoiseProcess.h.

#include <TRestRawSignalAddNoiseProcess.h>

Inheritance diagram for TRestRawSignalAddNoiseProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRawSignalAddNoiseProcess, 2)
 
RESTValue GetInputEvent () const override
 Returns a pointer to the input signal event. More...
 
Double_t GetNoiseLevel () const
 It returns the noise level defined in the process (ADC units) More...
 
RESTValue GetOutputEvent () const override
 Returns a pointer to the output signal event. More...
 
TRestMetadataGetProcessMetadata () const
 
const char * GetProcessName () const override
 Returns a given process name. 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
 Prints out the metadata members of this class. More...
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 The main processing event function. More...
 
void SetNoiseLevel (Double_t noiseLevel)
 It sets the noise level of the process (ADC units) More...
 
 TRestRawSignalAddNoiseProcess ()
 Default constructor. More...
 
 TRestRawSignalAddNoiseProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestRawSignalAddNoiseProcess ()
 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

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

TRestRawSignalEventfInputSignalEvent
 A pointer to the input signal event. More...
 
Double_t fNoiseLevel = 10.0
 The noise level to be added to the signal. It is 1-gaussian sigma. More...
 
TRestRawSignalEventfOutputSignalEvent
 A pointer to the output signal event. 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

◆ TRestRawSignalAddNoiseProcess() [1/2]

TRestRawSignalAddNoiseProcess::TRestRawSignalAddNoiseProcess ( )

Default constructor.

Definition at line 83 of file TRestRawSignalAddNoiseProcess.cxx.

◆ TRestRawSignalAddNoiseProcess() [2/2]

TRestRawSignalAddNoiseProcess::TRestRawSignalAddNoiseProcess ( 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 97 of file TRestRawSignalAddNoiseProcess.cxx.

◆ ~TRestRawSignalAddNoiseProcess()

TRestRawSignalAddNoiseProcess::~TRestRawSignalAddNoiseProcess ( )

Default destructor.

Definition at line 107 of file TRestRawSignalAddNoiseProcess.cxx.

Member Function Documentation

◆ GetInputEvent()

RESTValue TRestRawSignalAddNoiseProcess::GetInputEvent ( ) const
inlineoverridevirtual

Returns a pointer to the input signal event.

Implements TRestEventProcess.

Definition at line 54 of file TRestRawSignalAddNoiseProcess.h.

◆ GetNoiseLevel()

Double_t TRestRawSignalAddNoiseProcess::GetNoiseLevel ( ) const
inline

It returns the noise level defined in the process (ADC units)

Definition at line 48 of file TRestRawSignalAddNoiseProcess.h.

◆ GetOutputEvent()

RESTValue TRestRawSignalAddNoiseProcess::GetOutputEvent ( ) const
inlineoverridevirtual

Returns a pointer to the output signal event.

Implements TRestEventProcess.

Definition at line 57 of file TRestRawSignalAddNoiseProcess.h.

◆ GetProcessMetadata()

TRestMetadata * TRestRawSignalAddNoiseProcess::GetProcessMetadata ( ) const
inline

Definition at line 72 of file TRestRawSignalAddNoiseProcess.h.

◆ GetProcessName()

const char * TRestRawSignalAddNoiseProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns a given process name.

Implements TRestEventProcess.

Definition at line 75 of file TRestRawSignalAddNoiseProcess.h.

◆ Initialize()

void TRestRawSignalAddNoiseProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 124 of file TRestRawSignalAddNoiseProcess.cxx.

◆ LoadConfig()

void TRestRawSignalAddNoiseProcess::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 TRestRawSignalAddNoiseProcess.cxx.

◆ LoadDefaultConfig()

void TRestRawSignalAddNoiseProcess::LoadDefaultConfig ( )
private

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

Definition at line 115 of file TRestRawSignalAddNoiseProcess.cxx.

◆ PrintMetadata()

void TRestRawSignalAddNoiseProcess::PrintMetadata ( )
inlineoverridevirtual

Prints out the metadata members of this class.

Reimplemented from TRestMetadata.

Definition at line 64 of file TRestRawSignalAddNoiseProcess.h.

◆ ProcessEvent()

TRestEvent * TRestRawSignalAddNoiseProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 153 of file TRestRawSignalAddNoiseProcess.cxx.

◆ SetNoiseLevel()

void TRestRawSignalAddNoiseProcess::SetNoiseLevel ( Double_t  noiseLevel)
inline

It sets the noise level of the process (ADC units)

Definition at line 51 of file TRestRawSignalAddNoiseProcess.h.

Field Documentation

◆ fInputSignalEvent

TRestRawSignalEvent* TRestRawSignalAddNoiseProcess::fInputSignalEvent
private

A pointer to the input signal event.

Definition at line 34 of file TRestRawSignalAddNoiseProcess.h.

◆ fNoiseLevel

Double_t TRestRawSignalAddNoiseProcess::fNoiseLevel = 10.0
private

The noise level to be added to the signal. It is 1-gaussian sigma.

Definition at line 44 of file TRestRawSignalAddNoiseProcess.h.

◆ fOutputSignalEvent

TRestRawSignalEvent* TRestRawSignalAddNoiseProcess::fOutputSignalEvent
private

A pointer to the output signal event.

Definition at line 37 of file TRestRawSignalAddNoiseProcess.h.


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