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

Detailed Description

An analysis REST process to extract valuable information from RawSignal type of data.

Fit every TRestRawSignal in a TRestRawSignalEvent with AGET theoretical curve times a logistic function. This logistic function acts like a step function to select only the positive range of the AGET function. Working with raw signal (without subtracting baseline).

From TRestRawSignal -> TH1 -> Measure goodness of fit

Analytic expression to fit:

[0]+[1]*TMath::Exp(-3. * (x-[3])/[2]) * (x-[3])/[2] * (x-[3])/[2] *
(x-[3])/[2] * sin((x-[3])/[2])/(1+TMath::Exp(-x+[3]))
[0] = "Baseline",
[1] = "Amplitude",
[2] = "ShapingTime",
[3] = "PeakPosition"

Example of fitted pulse

Observables


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-August First implementation of raw signal fitting process. Created from TRestRawSignalAnalysisProcess.

Author
David Diez

Definition at line 34 of file TRestRawSignalFittingProcess.h.

#include <TRestRawSignalFittingProcess.h>

Inheritance diagram for TRestRawSignalFittingProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestRawSignalFittingProcess, 2)
 
void EndProcess () override
 Function to include required actions after all events have been processed. This method will write the channels histogram. More...
 
Double_t GetAmplitude () const
 
Double_t GetBaseline () const
 
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
 
Double_t GetShaping () const
 
Double_t GetStartPosition () const
 
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...
 
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...
 
 TRestRawSignalFittingProcess ()
 Default constructor. More...
 
 TRestRawSignalFittingProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestRawSignalFittingProcess ()
 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

Double_t fAmplitude = 0
 
Double_t fBaseline = 0
 
TRestRawSignalEventfRawSignalEvent
 A pointer to the specific TRestRawSignalEvent input. More...
 
Double_t fShaping = 0
 
Double_t fStartPosition = 0
 

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

◆ TRestRawSignalFittingProcess() [1/2]

TRestRawSignalFittingProcess::TRestRawSignalFittingProcess ( )

Default constructor.

Definition at line 108 of file TRestRawSignalFittingProcess.cxx.

◆ TRestRawSignalFittingProcess() [2/2]

TRestRawSignalFittingProcess::TRestRawSignalFittingProcess ( 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 122 of file TRestRawSignalFittingProcess.cxx.

◆ ~TRestRawSignalFittingProcess()

TRestRawSignalFittingProcess::~TRestRawSignalFittingProcess ( )

Default destructor.

Definition at line 131 of file TRestRawSignalFittingProcess.cxx.

Member Function Documentation

◆ EndProcess()

void TRestRawSignalFittingProcess::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 326 of file TRestRawSignalFittingProcess.cxx.

◆ GetAmplitude()

Double_t TRestRawSignalFittingProcess::GetAmplitude ( ) const
inline

Definition at line 58 of file TRestRawSignalFittingProcess.h.

◆ GetBaseline()

Double_t TRestRawSignalFittingProcess::GetBaseline ( ) const
inline

Definition at line 57 of file TRestRawSignalFittingProcess.h.

◆ GetInputEvent()

RESTValue TRestRawSignalFittingProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 52 of file TRestRawSignalFittingProcess.h.

◆ GetOutputEvent()

RESTValue TRestRawSignalFittingProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 53 of file TRestRawSignalFittingProcess.h.

◆ GetProcessName()

const char * TRestRawSignalFittingProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 72 of file TRestRawSignalFittingProcess.h.

◆ GetShaping()

Double_t TRestRawSignalFittingProcess::GetShaping ( ) const
inline

Definition at line 55 of file TRestRawSignalFittingProcess.h.

◆ GetStartPosition()

Double_t TRestRawSignalFittingProcess::GetStartPosition ( ) const
inline

Definition at line 56 of file TRestRawSignalFittingProcess.h.

◆ Initialize()

void TRestRawSignalFittingProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 142 of file TRestRawSignalFittingProcess.cxx.

◆ InitProcess()

void TRestRawSignalFittingProcess::InitProcess ( )
overridevirtual

Process initialization.

Reimplemented from TRestEventProcess.

Definition at line 168 of file TRestRawSignalFittingProcess.cxx.

◆ LoadConfig()

void TRestRawSignalFittingProcess::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 161 of file TRestRawSignalFittingProcess.cxx.

◆ LoadDefaultConfig()

void TRestRawSignalFittingProcess::LoadDefaultConfig ( )
private

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

Definition at line 136 of file TRestRawSignalFittingProcess.cxx.

◆ PrintMetadata()

void TRestRawSignalFittingProcess::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 66 of file TRestRawSignalFittingProcess.h.

◆ ProcessEvent()

TRestEvent * TRestRawSignalFittingProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

We define (or re-define) the baseline range and calculation range of our raw-signals.

Implements TRestEventProcess.

Definition at line 175 of file TRestRawSignalFittingProcess.cxx.

Field Documentation

◆ fAmplitude

Double_t TRestRawSignalFittingProcess::fAmplitude = 0
private

Definition at line 46 of file TRestRawSignalFittingProcess.h.

◆ fBaseline

Double_t TRestRawSignalFittingProcess::fBaseline = 0
private

Definition at line 45 of file TRestRawSignalFittingProcess.h.

◆ fRawSignalEvent

TRestRawSignalEvent* TRestRawSignalFittingProcess::fRawSignalEvent
private

A pointer to the specific TRestRawSignalEvent input.

Definition at line 37 of file TRestRawSignalFittingProcess.h.

◆ fShaping

Double_t TRestRawSignalFittingProcess::fShaping = 0
private

Definition at line 43 of file TRestRawSignalFittingProcess.h.

◆ fStartPosition

Double_t TRestRawSignalFittingProcess::fStartPosition = 0
private

Definition at line 44 of file TRestRawSignalFittingProcess.h.


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