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

Detailed Description

An analysis REST process to extract valuable information from Hits type of data performing gaussian fits.

This process is internal to the library. That means the input and output event is the event type corresponding to the library, i.e. TRestDetectorHitsEvent.

Observables

Position statistics


RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2020-Sep: First implementation Cristina Margalejo

Author
Cristina Margalejo

Definition at line 36 of file TRestDetectorHitsGaussAnalysisProcess.h.

#include <TRestDetectorHitsGaussAnalysisProcess.h>

Inheritance diagram for TRestDetectorHitsGaussAnalysisProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestDetectorHitsGaussAnalysisProcess, 2)
 
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 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...
 
 TRestDetectorHitsGaussAnalysisProcess ()
 Default constructor. More...
 
 TRestDetectorHitsGaussAnalysisProcess (const char *configFilename)
 Constructor loading data from a config file. More...
 
 ~TRestDetectorHitsGaussAnalysisProcess ()
 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

Double_t fError = 150
 Error assigned to the hits on the sides. More...
 
Int_t fNHitsMin = 100000
 The minimum number of hits required to apply the hit correction. More...
 
Double_t fPitch = 0.5
 The pitch or size of the strips in mm. 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 and library version. More...
 
void InitProcess () override
 Function to use in initialization of process members before starting to process the event. More...
 
void LoadDefaultConfig ()
 Function to load the default config in absence of RML input. More...
 

Private Attributes

TRestDetectorHitsEventfInputHitsEvent
 A pointer to the specific TRestDetectorHitsEvent. More...
 
TRestDetectorHitsEventfOutputHitsEvent
 

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

◆ TRestDetectorHitsGaussAnalysisProcess() [1/2]

TRestDetectorHitsGaussAnalysisProcess::TRestDetectorHitsGaussAnalysisProcess ( )

Default constructor.

Definition at line 64 of file TRestDetectorHitsGaussAnalysisProcess.cxx.

◆ TRestDetectorHitsGaussAnalysisProcess() [2/2]

TRestDetectorHitsGaussAnalysisProcess::TRestDetectorHitsGaussAnalysisProcess ( const char *  configFilename)

Constructor loading data from a config file.

The path to the config file can be specified using full path, absolute or relative.

If the file is not found then REST will try to find the file on the default paths defined in REST Framework, usually at the REST_PATH installation directory. Additional search paths may be defined using the parameter searchPath in globals section. See TRestMetadata description.

Parameters
configFilenameA const char* giving the path to an RML file.

Definition at line 80 of file TRestDetectorHitsGaussAnalysisProcess.cxx.

◆ ~TRestDetectorHitsGaussAnalysisProcess()

TRestDetectorHitsGaussAnalysisProcess::~TRestDetectorHitsGaussAnalysisProcess ( )

Default destructor.

Definition at line 89 of file TRestDetectorHitsGaussAnalysisProcess.cxx.

Member Function Documentation

◆ GetInputEvent()

RESTValue TRestDetectorHitsGaussAnalysisProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 60 of file TRestDetectorHitsGaussAnalysisProcess.h.

◆ GetOutputEvent()

RESTValue TRestDetectorHitsGaussAnalysisProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 61 of file TRestDetectorHitsGaussAnalysisProcess.h.

◆ GetProcessName()

const char * TRestDetectorHitsGaussAnalysisProcess::GetProcessName ( ) const
inlineoverridevirtual

Returns the name of this process.

Implements TRestEventProcess.

Definition at line 73 of file TRestDetectorHitsGaussAnalysisProcess.h.

◆ Initialize()

void TRestDetectorHitsGaussAnalysisProcess::Initialize ( )
overrideprivatevirtual

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

Reimplemented from TRestMetadata.

Definition at line 131 of file TRestDetectorHitsGaussAnalysisProcess.cxx.

◆ InitProcess()

void TRestDetectorHitsGaussAnalysisProcess::InitProcess ( )
overrideprivatevirtual

Function to use in initialization of process members before starting to process the event.

Reimplemented from TRestEventProcess.

Definition at line 122 of file TRestDetectorHitsGaussAnalysisProcess.cxx.

◆ LoadConfig()

void TRestDetectorHitsGaussAnalysisProcess::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 TRestDetectorHitsGaussAnalysisProcess section inside the RML.

Definition at line 114 of file TRestDetectorHitsGaussAnalysisProcess.cxx.

◆ LoadDefaultConfig()

void TRestDetectorHitsGaussAnalysisProcess::LoadDefaultConfig ( )
private

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

Definition at line 97 of file TRestDetectorHitsGaussAnalysisProcess.cxx.

◆ Maker()

TRestEventProcess * TRestDetectorHitsGaussAnalysisProcess::Maker ( )
inline

Returns a new instance of this class.

Definition at line 70 of file TRestDetectorHitsGaussAnalysisProcess.h.

◆ PrintMetadata()

void TRestDetectorHitsGaussAnalysisProcess::PrintMetadata ( )
overridevirtual

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

Reimplemented from TRestMetadata.

Definition at line 198 of file TRestDetectorHitsGaussAnalysisProcess.cxx.

◆ ProcessEvent()

TRestEvent * TRestDetectorHitsGaussAnalysisProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

The main processing event function.

Implements TRestEventProcess.

Definition at line 143 of file TRestDetectorHitsGaussAnalysisProcess.cxx.

Field Documentation

◆ fError

Double_t TRestDetectorHitsGaussAnalysisProcess::fError = 150
protected

Error assigned to the hits on the sides.

Definition at line 54 of file TRestDetectorHitsGaussAnalysisProcess.h.

◆ fInputHitsEvent

TRestDetectorHitsEvent* TRestDetectorHitsGaussAnalysisProcess::fInputHitsEvent
private

A pointer to the specific TRestDetectorHitsEvent.

Definition at line 40 of file TRestDetectorHitsGaussAnalysisProcess.h.

◆ fNHitsMin

Int_t TRestDetectorHitsGaussAnalysisProcess::fNHitsMin = 100000
protected

The minimum number of hits required to apply the hit correction.

Definition at line 57 of file TRestDetectorHitsGaussAnalysisProcess.h.

◆ fOutputHitsEvent

TRestDetectorHitsEvent* TRestDetectorHitsGaussAnalysisProcess::fOutputHitsEvent
private

Definition at line 41 of file TRestDetectorHitsGaussAnalysisProcess.h.

◆ fPitch

Double_t TRestDetectorHitsGaussAnalysisProcess::fPitch = 0.5
protected

The pitch or size of the strips in mm.

Definition at line 51 of file TRestDetectorHitsGaussAnalysisProcess.h.


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