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

Detailed Description

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

Observables

Energy and number of tracks:

Max track energies, energy balance and track energy ratio:

Maximum Second Track Energy observables:

Track Length observables:

Track Volume observables:

Mean position for max energy tracks:

Mean position for second max energy tracks:

Mean position: Very similar to the previous observables, main difference all tracks (XYZ, XZ, YZ) together.

Main track distance measures the distance in X,Y,Z between the most energetic and second most energetic tracks.

The sigma parameter measures the cluster size obtained from a given track hits weighted with each hit energy.

The gaussian sigma parameter measures the cluster size obtained from the fit to a gaussian of a given track hits.

Time observables:


RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2016-March: First implementation of Geant4 analysis process into REST_v2. Javier Galan

2018-May: Added twist parameters.

Author
Javier Galan

Definition at line 31 of file TRestTrackAnalysisProcess.h.

#include <TRestTrackAnalysisProcess.h>

Inheritance diagram for TRestTrackAnalysisProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestTrackAnalysisProcess, 1)
 
void EndProcess () override
 To be executed at the end of the run (outside event loop)
 
RESTValue GetInputEvent () const override
 Get pointer to input event. Must be implemented in the derived class.
 
RESTValue GetOutputEvent () const override
 Get pointer to output event. Must be implemented in the derived class.
 
const char * GetProcessName () const override
 
void InitProcess () override
 To be executed at the beginning of the run (outside event loop)
 
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...
 
 TRestTrackAnalysisProcess (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()
 
 ClassDefOverride (TRestEventProcess, 3)
 
virtual void EndOfEventProcess (TRestEvent *inputEvent=nullptr)
 End of event process. Nothing to do. Called directly after ProcessEvent()
 
TRestAnalysisTreeGetAnalysisTree () const
 Return the local analysis tree (dummy)
 
TCanvas * GetCanvas () const
 Get canvas.
 
TRestAnalysisTreeGetFullAnalysisTree ()
 
std::vector< std::string > GetListOfAddedObservables ()
 
TRestRunGetRunInfo () const
 Return the pointer of the hosting TRestRun object.
 
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.
 
Bool_t isExternal () const
 Return whether this process is external process.
 
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.
 
virtual Bool_t OpenInputFiles (const std::vector< std::string > &files)
 
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.
 
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.
 
Bool_t singleThreadOnly () const
 Return whether this process is single std::thread only.
 
 TRestEventProcess ()
 
 ~TRestEventProcess ()
 

Protected Attributes

Double_t fDeltaEnergy
 
TVector2 fNTracksXCut
 
TVector2 fNTracksYCut
 
- Protected Attributes inherited from TRestEventProcess
TRestAnalysisTreefAnalysisTree = nullptr
 
TCanvas * fCanvas = nullptr
 < Canvas for some viewer event
 
TVector2 fCanvasSize
 Canvas size.
 
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.
 
bool fIsExternal = false
 It defines if the process reads event data from an external source.
 
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.
 
bool fReadOnly = false
 not used, keep for compatibility
 
TRestRunfRunInfo = nullptr
 < Pointer to TRestRun object where to find metadata.
 
bool fSingleThreadOnly = false
 
bool fValidateObservables = false
 It defines if observable names should be added to the validation list.
 

Private Member Functions

void InitFromConfigFile () override
 To make settings from rml file. This method must be implemented in the derived class.
 
void Initialize () override
 Making default settings.
 
void LoadDefaultConfig ()
 

Private Attributes

Bool_t fCutsEnabled
 
Bool_t fEnableTwistParameters
 
TRestTrackEventfInputTrackEvent
 
TRestTrackEventfOutputTrackEvent
 
std::vector< Double_t > fPreviousEventTime
 
std::vector< std::string > fTrack_En_EnergyObservables
 
std::vector< Double_t > fTrack_En_Threshold
 
std::vector< std::string > fTrack_HE_EnergyObservables
 
std::vector< Double_t > fTrack_HE_Threshold
 
std::vector< std::string > fTrack_LE_EnergyObservables
 
std::vector< Double_t > fTrack_LE_Threshold
 
std::vector< TString > fTwistBalanceObservables
 
std::vector< TString > fTwistBalanceObservables_X
 
std::vector< TString > fTwistBalanceObservables_Y
 
std::vector< Double_t > fTwistBalanceTailPercentage
 
std::vector< Double_t > fTwistBalanceTailPercentage_X
 
std::vector< Double_t > fTwistBalanceTailPercentage_Y
 
std::vector< Double_t > fTwistBalanceValue
 
std::vector< Double_t > fTwistBalanceValue_X
 
std::vector< Double_t > fTwistBalanceValue_Y
 
std::vector< TString > fTwistHighObservables
 
std::vector< TString > fTwistHighObservables_X
 
std::vector< TString > fTwistHighObservables_Y
 
std::vector< Double_t > fTwistHighTailPercentage
 
std::vector< Double_t > fTwistHighTailPercentage_X
 
std::vector< Double_t > fTwistHighTailPercentage_Y
 
std::vector< Double_t > fTwistHighValue
 
std::vector< Double_t > fTwistHighValue_X
 
std::vector< Double_t > fTwistHighValue_Y
 
std::vector< TString > fTwistLowObservables
 
std::vector< TString > fTwistLowObservables_X
 
std::vector< TString > fTwistLowObservables_Y
 
std::vector< Double_t > fTwistLowTailPercentage
 
std::vector< Double_t > fTwistLowTailPercentage_X
 
std::vector< Double_t > fTwistLowTailPercentage_Y
 
std::vector< Double_t > fTwistLowValue
 
std::vector< Double_t > fTwistLowValue_X
 
std::vector< Double_t > fTwistLowValue_Y
 
std::vector< TString > fTwistRatioObservables
 
std::vector< TString > fTwistRatioObservables_X
 
std::vector< TString > fTwistRatioObservables_Y
 
std::vector< Double_t > fTwistRatioTailPercentage
 
std::vector< Double_t > fTwistRatioTailPercentage_X
 
std::vector< Double_t > fTwistRatioTailPercentage_Y
 
std::vector< Double_t > fTwistRatioValue
 
std::vector< Double_t > fTwistRatioValue_X
 
std::vector< Double_t > fTwistRatioValue_Y
 
std::vector< TString > fTwistWeightedHighObservables
 
std::vector< TString > fTwistWeightedHighObservables_X
 
std::vector< TString > fTwistWeightedHighObservables_Y
 
std::vector< Double_t > fTwistWeightedHighTailPercentage
 
std::vector< Double_t > fTwistWeightedHighTailPercentage_X
 
std::vector< Double_t > fTwistWeightedHighTailPercentage_Y
 
std::vector< Double_t > fTwistWeightedHighValue
 
std::vector< Double_t > fTwistWeightedHighValue_X
 
std::vector< Double_t > fTwistWeightedHighValue_Y
 
std::vector< TString > fTwistWeightedLowObservables
 
std::vector< TString > fTwistWeightedLowObservables_X
 
std::vector< TString > fTwistWeightedLowObservables_Y
 
std::vector< Double_t > fTwistWeightedLowTailPercentage
 
std::vector< Double_t > fTwistWeightedLowTailPercentage_X
 
std::vector< Double_t > fTwistWeightedLowTailPercentage_Y
 
std::vector< Double_t > fTwistWeightedLowValue
 
std::vector< Double_t > fTwistWeightedLowValue_X
 
std::vector< Double_t > fTwistWeightedLowValue_Y
 
std::vector< Int_t > nTracks_En
 
std::vector< Int_t > nTracks_HE
 
std::vector< Int_t > nTracks_LE
 

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.
 
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...
 

Member Function Documentation

◆ PrintMetadata()

void TRestTrackAnalysisProcess::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 151 of file TRestTrackAnalysisProcess.h.

◆ ProcessEvent()

TRestEvent * TRestTrackAnalysisProcess::ProcessEvent ( TRestEvent inputEvent)
overridevirtual

Process one event.

This kind of observables would be better in a separate process that measures the trigger rate

Implements TRestEventProcess.

Definition at line 435 of file TRestTrackAnalysisProcess.cxx.


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