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

Detailed Description

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

Analysis process for 3D tracks, XYZ. For other types of tracks all observables are 0.

Observables

"NTracks", fTrackEvent->GetNumberOfTracks()); "TotalEnergy", fTrackEvent->GetEnergy()); "XYZ_MaxTrackEnergyPercentage", Percentage of first track energy from total energy "XYZ_SecondMaxTrackEnergyPercentage", Percentage of second track energy from total energy "XYZ_FirstSecondTracksDistance", Distance in XYZ of mean positions of first two XYZ tracks

Map observables, there are the same observables for first and second tracks. MaxTrack_... and SecondMaxTrack_... Map observables have values for each track of each observable. Only for XYZ tracks, if not = 0

SetObservableValue("Map_XYZ_NHits", XYZ_NHits); SetObservableValue("Map_XYZ_Energy", XYZ_Energy); SetObservableValue("Map_XYZ_SigmaX", XYZ_SigmaX); SetObservableValue("Map_XYZ_SigmaY", XYZ_SigmaY); SetObservableValue("Map_XYZ_SigmaZ", XYZ_SigmaZ); SetObservableValue("Map_XYZ_GaussSigmaX", XYZ_GaussSigmaX); SetObservableValue("Map_XYZ_GaussSigmaY", XYZ_GaussSigmaY); SetObservableValue("Map_XYZ_GaussSigmaZ", XYZ_GaussSigmaZ); SetObservableValue("Map_XYZ_Length", XYZ_Length); SetObservableValue("Map_XYZ_Volume", XYZ_Volume); SetObservableValue("Map_XYZ_MeanX", XYZ_MeanX); SetObservableValue("Map_XYZ_MeanY", XYZ_MeanY); SetObservableValue("Map_XYZ_MeanZ", XYZ_MeanZ); SetObservableValue("Map_XYZ_SkewXY", XYZ_SkewXY); SetObservableValue("Map_XYZ_SkewZ", XYZ_SkewZ);


RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2024-March: Analysis for 3D tracks (XYZ) David Diez Ibanez

Author
David Diez Ibanez

Definition at line 31 of file TRestTrack3DAnalysisProcess.h.

#include <TRestTrack3DAnalysisProcess.h>

Inheritance diagram for TRestTrack3DAnalysisProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestTrack3DAnalysisProcess, 1)
 
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
 
void InitProcess () override
 To be executed at the beginning of the run (outside event loop) More...
 
void LoadConfig (const std::string &configFilename, const std::string &name="")
 
void PrintMetadata () override
 Implemented it in the derived metadata class to print out specific metadata information. More...
 
TRestEventProcessEvent (TRestEvent *inputEvent) override
 Process one event. More...
 
 TRestTrack3DAnalysisProcess (const char *configFilename)
 
- 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 InitFromConfigFile () override
 To make settings from rml file. This method must be implemented in the derived class. More...
 
void Initialize () override
 Making default settings. More...
 
void LoadDefaultConfig ()
 

Private Attributes

TRestTrackEventfTrackEvent
 

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

◆ TRestTrack3DAnalysisProcess() [1/2]

TRestTrack3DAnalysisProcess::TRestTrack3DAnalysisProcess ( )

Definition at line 85 of file TRestTrack3DAnalysisProcess.cxx.

◆ TRestTrack3DAnalysisProcess() [2/2]

TRestTrack3DAnalysisProcess::TRestTrack3DAnalysisProcess ( const char *  configFilename)

Definition at line 87 of file TRestTrack3DAnalysisProcess.cxx.

◆ ~TRestTrack3DAnalysisProcess()

TRestTrack3DAnalysisProcess::~TRestTrack3DAnalysisProcess ( )

Definition at line 92 of file TRestTrack3DAnalysisProcess.cxx.

Member Function Documentation

◆ EndProcess()

void TRestTrack3DAnalysisProcess::EndProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 307 of file TRestTrack3DAnalysisProcess.cxx.

◆ GetInputEvent()

RESTValue TRestTrack3DAnalysisProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 43 of file TRestTrack3DAnalysisProcess.h.

◆ GetOutputEvent()

RESTValue TRestTrack3DAnalysisProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 44 of file TRestTrack3DAnalysisProcess.h.

◆ GetProcessName()

const char * TRestTrack3DAnalysisProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 60 of file TRestTrack3DAnalysisProcess.h.

◆ InitFromConfigFile()

void TRestTrack3DAnalysisProcess::InitFromConfigFile ( )
overrideprivatevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 309 of file TRestTrack3DAnalysisProcess.cxx.

◆ Initialize()

void TRestTrack3DAnalysisProcess::Initialize ( )
overrideprivatevirtual

Making default settings.

Reimplemented from TRestMetadata.

Definition at line 96 of file TRestTrack3DAnalysisProcess.cxx.

◆ InitProcess()

void TRestTrack3DAnalysisProcess::InitProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 107 of file TRestTrack3DAnalysisProcess.cxx.

◆ LoadConfig()

void TRestTrack3DAnalysisProcess::LoadConfig ( const std::string &  configFilename,
const std::string &  name = "" 
)

Definition at line 103 of file TRestTrack3DAnalysisProcess.cxx.

◆ LoadDefaultConfig()

void TRestTrack3DAnalysisProcess::LoadDefaultConfig ( )
private

Definition at line 94 of file TRestTrack3DAnalysisProcess.cxx.

◆ PrintMetadata()

void TRestTrack3DAnalysisProcess::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 52 of file TRestTrack3DAnalysisProcess.h.

◆ ProcessEvent()

TRestEvent * TRestTrack3DAnalysisProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

Process one event.

-----------------------------------------------— /// ---------------— OBSERVABLES ----------------— /// -----------------------------------------------— ///

---— MAP OBSERVABLES ---— //// Energy per track

Number of hits in the track

Standard deviation observables

Skew observables

Gauss sigma observables

Espacial measuremets

Distance between biggest two tracks in energy

-------------------------------------------------------— /// ---------------— COMPUTE OBSERVABLES ----------------— /// -------------------------------------------------------— ///

Map observables

Sort tracks by energy ///

From map to vector

Sort the vector by decreasing order of its pair's second value

Distance between first two tracks

----------------------------------------------------------— /// ---------------— SET OBSERVABLES VALUES ----------------— /// ----------------------------------------------------------— ///

Implements TRestEventProcess.

Definition at line 109 of file TRestTrack3DAnalysisProcess.cxx.

Field Documentation

◆ fTrackEvent

TRestTrackEvent* TRestTrack3DAnalysisProcess::fTrackEvent
private

Definition at line 33 of file TRestTrack3DAnalysisProcess.h.


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