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

Detailed Description

A process to subtract the common channels noise from RawSignal type.

BASIC DOCUMENTATION : Full documentation to be added. A figure with the the pulses before and after applying the process.

This process tries to reduce the common noise of TRestRawSignals by two means :

Common noise identification in all signals or by blocks Written with TREX-DM architecture in mind (8 blocks with 68 signals each and gap of 4 ID between blocks)

Output signal without base line subtraction.


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-July: First implementation of common noise reduction process. Benjamin Manier

2020-October: Base line not subtracted. David Diez

Author
Benjamin Manier
David Diez

Definition at line 32 of file TRestRawCommonNoiseReductionProcess.h.

#include <TRestRawCommonNoiseReductionProcess.h>

Inheritance diagram for TRestRawCommonNoiseReductionProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRawCommonNoiseReductionProcess, 3)
 
void EndProcess () override
 Function to include required actions after all events have been processed. This method will write the channels histogram. 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 reduced process name. More...
 
void InitProcess () override
 Process initialization. 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
 Implemented it in the derived metadata class to print out specific metadata information. More...
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 The main processing event function. More...
 
 TRestRawCommonNoiseReductionProcess ()
 Default constructor. More...
 
 TRestRawCommonNoiseReductionProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestRawCommonNoiseReductionProcess ()
 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

Int_t fBlocks = 0
 Common noise to all signals or by groups (It can be 0 or 1). More...
 
Int_t fCenterWidth = 10
 
std::string fChannelType
 
TRestRawSignalEventfInputEvent
 A pointer to the specific TRestRawSignalEvent input. More...
 
Int_t fMinSignalsRequired = 200
 Minimum number of signals required to apply the process. More...
 
Int_t fMode = 0
 The mode defines the method to be used (It can be 0 or 1). More...
 
TRestRawSignalEventfOutputEvent
 A pointer to the specific TRestRawSignalEvent output. 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...
 
- 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

◆ TRestRawCommonNoiseReductionProcess() [1/2]

TRestRawCommonNoiseReductionProcess::TRestRawCommonNoiseReductionProcess ( )

Default constructor.

Definition at line 99 of file TRestRawCommonNoiseReductionProcess.cxx.

◆ TRestRawCommonNoiseReductionProcess() [2/2]

TRestRawCommonNoiseReductionProcess::TRestRawCommonNoiseReductionProcess ( 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 113 of file TRestRawCommonNoiseReductionProcess.cxx.

◆ ~TRestRawCommonNoiseReductionProcess()

TRestRawCommonNoiseReductionProcess::~TRestRawCommonNoiseReductionProcess ( )

Default destructor.

Definition at line 124 of file TRestRawCommonNoiseReductionProcess.cxx.

Member Function Documentation

◆ EndProcess()

void TRestRawCommonNoiseReductionProcess::EndProcess ( )
overridevirtual

Function to include required actions after all events have been processed. This method will write the channels histogram.

Reimplemented from TRestEventProcess.

Definition at line 382 of file TRestRawCommonNoiseReductionProcess.cxx.

◆ GetInputEvent()

RESTValue TRestRawCommonNoiseReductionProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 61 of file TRestRawCommonNoiseReductionProcess.h.

◆ GetOutputEvent()

RESTValue TRestRawCommonNoiseReductionProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 62 of file TRestRawCommonNoiseReductionProcess.h.

◆ GetProcessName()

const char * TRestRawCommonNoiseReductionProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the reduced process name.

Implements TRestEventProcess.

Definition at line 97 of file TRestRawCommonNoiseReductionProcess.h.

◆ Initialize()

void TRestRawCommonNoiseReductionProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 138 of file TRestRawCommonNoiseReductionProcess.cxx.

◆ InitProcess()

void TRestRawCommonNoiseReductionProcess::InitProcess ( )
overridevirtual

Process initialization.

Reimplemented from TRestEventProcess.

Definition at line 167 of file TRestRawCommonNoiseReductionProcess.cxx.

◆ LoadConfig()

void TRestRawCommonNoiseReductionProcess::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 158 of file TRestRawCommonNoiseReductionProcess.cxx.

◆ LoadDefaultConfig()

void TRestRawCommonNoiseReductionProcess::LoadDefaultConfig ( )
private

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

Definition at line 132 of file TRestRawCommonNoiseReductionProcess.cxx.

◆ Maker()

TRestEventProcess * TRestRawCommonNoiseReductionProcess::Maker ( )
inline

Returns a new instance of this class.

Definition at line 94 of file TRestRawCommonNoiseReductionProcess.h.

◆ PrintMetadata()

void TRestRawCommonNoiseReductionProcess::PrintMetadata ( )
inlineoverridevirtual

Implemented it in the derived metadata class to print out specific metadata information.

Prints metadata content on screen. Usually overloaded by the derived metadata class.

Reimplemented from TRestMetadata.

Definition at line 72 of file TRestRawCommonNoiseReductionProcess.h.

◆ ProcessEvent()

TRestEvent * TRestRawCommonNoiseReductionProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 172 of file TRestRawCommonNoiseReductionProcess.cxx.

Field Documentation

◆ fBlocks

Int_t TRestRawCommonNoiseReductionProcess::fBlocks = 0
private

Common noise to all signals or by groups (It can be 0 or 1).

Definition at line 41 of file TRestRawCommonNoiseReductionProcess.h.

◆ fCenterWidth

Int_t TRestRawCommonNoiseReductionProcess::fCenterWidth = 10
private

The percentage of signals taken from the array center to be considered for the average.

Definition at line 48 of file TRestRawCommonNoiseReductionProcess.h.

◆ fChannelType

std::string TRestRawCommonNoiseReductionProcess::fChannelType
private

Definition at line 53 of file TRestRawCommonNoiseReductionProcess.h.

◆ fInputEvent

TRestRawSignalEvent* TRestRawCommonNoiseReductionProcess::fInputEvent
private

A pointer to the specific TRestRawSignalEvent input.

Definition at line 35 of file TRestRawCommonNoiseReductionProcess.h.

◆ fMinSignalsRequired

Int_t TRestRawCommonNoiseReductionProcess::fMinSignalsRequired = 200
private

Minimum number of signals required to apply the process.

Definition at line 51 of file TRestRawCommonNoiseReductionProcess.h.

◆ fMode

Int_t TRestRawCommonNoiseReductionProcess::fMode = 0
private

The mode defines the method to be used (It can be 0 or 1).

Definition at line 44 of file TRestRawCommonNoiseReductionProcess.h.

◆ fOutputEvent

TRestRawSignalEvent* TRestRawCommonNoiseReductionProcess::fOutputEvent
private

A pointer to the specific TRestRawSignalEvent output.

Definition at line 38 of file TRestRawCommonNoiseReductionProcess.h.

◆ fReadoutMetadata

TRestRawReadoutMetadata* TRestRawCommonNoiseReductionProcess::fReadoutMetadata = nullptr
private

Definition at line 54 of file TRestRawCommonNoiseReductionProcess.h.


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