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

Detailed Description

A process that corrects the BaseLine. The parameter "SmoothingWindow" sets the time window (number of
bins) used for the moving average filter that is used for the baseline correction. Standard value is 75.
The range of signal IDs, to which the process is applied, can be selected with the parameter
"SignalsRange". The process can be added to the analysis rml for example like \code
  <addProcess type="TRestRawBaseLineCorrectionProcess" name="blCorrection" value="ON"
  verboseLevel="silent">
      <parameter name="signalsRange" value="(4610,4900)" />
      <parameter name="smoothingWindow" value="75" />
  </addProcess>
\endcode
\htmlonly <style>div.image

/// img[src="doc_TRestRawBaseLineCorrectionProcess1.png"]{width:750px;}</style>

![A raw signal with and without TRestBaseLineCorrectionProcess with smoothing window size
75](doc_TRestRawBaseLineCorrectionProcess1.png)

\htmlonly <style>div.image

/// img[src="doc_TRestRawBaseLineCorrectionProcess2.png"]{width:750px;}</style>

![A raw signal with and without TRestBaseLineCorrectionProcess with smoothing window size
75](doc_TRestRawBaseLineCorrectionProcess2.png) <hr>

\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](http://ezpc10.unizar.es). You are welcome to contribute fixing typos,
updating
information or adding/proposing new contributions. See also our
<a href="https://github.com/rest-for-physics/framework/blob/master/CONTRIBUTING.md">Contribution
Guide</a>.

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2022-Mar: First implementation Konrad Altenmueller

Author
Konrad Altenmueller

Definition at line 30 of file TRestRawBaseLineCorrectionProcess.h.

Inheritance diagram for TRestRawBaseLineCorrectionProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRawBaseLineCorrectionProcess, 2)
 
void EndProcess () override
 To be executed at the end of the run (outside event loop) 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...
 
void InitFromConfigFile () override
 To make settings from rml file. This method must be implemented in the derived class. More...
 
void InitProcess () override
 To be executed at the beginning of the run (outside event loop) 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 *eventInput) override
 Process one event. 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
 Making default settings. More...
 

Private Attributes

std::set< std::string > fChannelTypes = {}
 
TRestRawSignalEventfInputEvent
 
TRestRawSignalEventfOutputEvent
 
Bool_t fRangeEnabled = false
 Just a flag to quickly determine if we have to apply the range filter. More...
 
TRestRawReadoutMetadatafReadoutMetadata = nullptr
 
TVector2 fSignalsRange = {-1, -1}
 It defines the signals id range where analysis is applied. More...
 
Int_t fSmoothingWindow = 75
 Time window width in bins for the moving average filter for baseline correction. 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

◆ TRestRawBaseLineCorrectionProcess()

TRestRawBaseLineCorrectionProcess::TRestRawBaseLineCorrectionProcess ( )

Definition at line 76 of file TRestRawBaseLineCorrectionProcess.cxx.

◆ ~TRestRawBaseLineCorrectionProcess()

TRestRawBaseLineCorrectionProcess::~TRestRawBaseLineCorrectionProcess ( )

Definition at line 78 of file TRestRawBaseLineCorrectionProcess.cxx.

Member Function Documentation

◆ EndProcess()

void TRestRawBaseLineCorrectionProcess::EndProcess ( )
overridevirtual

To be executed at the end of the run (outside event loop)

Reimplemented from TRestEventProcess.

Definition at line 175 of file TRestRawBaseLineCorrectionProcess.cxx.

◆ GetInputEvent()

RESTValue TRestRawBaseLineCorrectionProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 51 of file TRestRawBaseLineCorrectionProcess.h.

◆ GetOutputEvent()

RESTValue TRestRawBaseLineCorrectionProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 52 of file TRestRawBaseLineCorrectionProcess.h.

◆ GetProcessName()

const char * TRestRawBaseLineCorrectionProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 68 of file TRestRawBaseLineCorrectionProcess.h.

◆ InitFromConfigFile()

void TRestRawBaseLineCorrectionProcess::InitFromConfigFile ( )
overridevirtual

To make settings from rml file. This method must be implemented in the derived class.

Reimplemented from TRestEventProcess.

Definition at line 141 of file TRestRawBaseLineCorrectionProcess.cxx.

◆ Initialize()

void TRestRawBaseLineCorrectionProcess::Initialize ( )
overrideprivatevirtual

Making default settings.

Reimplemented from TRestMetadata.

Definition at line 83 of file TRestRawBaseLineCorrectionProcess.cxx.

◆ InitProcess()

void TRestRawBaseLineCorrectionProcess::InitProcess ( )
overridevirtual

To be executed at the beginning of the run (outside event loop)

Reimplemented from TRestEventProcess.

Definition at line 139 of file TRestRawBaseLineCorrectionProcess.cxx.

◆ Maker()

TRestEventProcess * TRestRawBaseLineCorrectionProcess::Maker ( )
inline

Returns a new instance of this class.

Definition at line 65 of file TRestRawBaseLineCorrectionProcess.h.

◆ PrintMetadata()

void TRestRawBaseLineCorrectionProcess::PrintMetadata ( )
overridevirtual

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 155 of file TRestRawBaseLineCorrectionProcess.cxx.

◆ ProcessEvent()

TRestEvent * TRestRawBaseLineCorrectionProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

Process one event.

Implements TRestEventProcess.

Definition at line 91 of file TRestRawBaseLineCorrectionProcess.cxx.

Field Documentation

◆ fChannelTypes

std::set<std::string> TRestRawBaseLineCorrectionProcess::fChannelTypes = {}
private

Definition at line 48 of file TRestRawBaseLineCorrectionProcess.h.

◆ fInputEvent

TRestRawSignalEvent* TRestRawBaseLineCorrectionProcess::fInputEvent
private

Definition at line 33 of file TRestRawBaseLineCorrectionProcess.h.

◆ fOutputEvent

TRestRawSignalEvent* TRestRawBaseLineCorrectionProcess::fOutputEvent
private

Definition at line 34 of file TRestRawBaseLineCorrectionProcess.h.

◆ fRangeEnabled

Bool_t TRestRawBaseLineCorrectionProcess::fRangeEnabled = false
private

Just a flag to quickly determine if we have to apply the range filter.

Definition at line 46 of file TRestRawBaseLineCorrectionProcess.h.

◆ fReadoutMetadata

TRestRawReadoutMetadata* TRestRawBaseLineCorrectionProcess::fReadoutMetadata = nullptr
private

Definition at line 35 of file TRestRawBaseLineCorrectionProcess.h.

◆ fSignalsRange

TVector2 TRestRawBaseLineCorrectionProcess::fSignalsRange = {-1, -1}
private

It defines the signals id range where analysis is applied.

Definition at line 40 of file TRestRawBaseLineCorrectionProcess.h.

◆ fSmoothingWindow

Int_t TRestRawBaseLineCorrectionProcess::fSmoothingWindow = 75
private

Time window width in bins for the moving average filter for baseline correction.

Definition at line 43 of file TRestRawBaseLineCorrectionProcess.h.


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