REST-for-Physics  v2.3
Rare Event Searches ToolKit for Physics
Loading...
Searching...
No Matches
TRestDetectorHitsAnalysisProcess Class Reference

Detailed Description

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

Observables

Related to the number of hits:

  • nHits: Number of punctual energy depositions (fNHits).
  • nHitsX: Number of punctual depositions detected in X channels.
  • nHitsY: Number of punctual depositions detected in Y channels.
  • balanceXYnHits: (nHitsX - nHitsY) / (nHitsX + nHitsY).
  • nHitsSizeXY: If (nHits == nHitsX) or (nHits == nHitsY) => nHitsSizeXY==nHits Else: nHitsSizeXY == (nHitsX^2+ nHitsY^2)^1/2.

Cylindrical fiducial volume:

  • isInsideCylindricalVolume: 1 if some hits of the event are inside the cylindrical fiducial volume, 0 if none is inside.
  • nInsideCylindricalVolume: Number of hits inside the cylindrical fiducial volume.
  • energyInsideCylindricalVolume: energy of the hits inside the cylindrical fiducial volume.
  • xMeanInCylinder: For all energy depositions inside the cylindrical fiducial volume it takes the mean position in X coordinate using the energies as weights.
  • yMeanInCylinder: For all energy depositions inside the cylindrical fiducial volume it takes the mean position in Y coordinate using the energies as weights.
  • zMeanInCylinder: For all energy depositions inside the cylindrical fiducial volume it takes the mean position in Z coordinate using the energies as weights.

Prism fiducial volume:

  • isInsidePrismVolume: It is a binary observable. It checks if the event has deposited energy inside the volume. To do so, it checks if GetNumberOfHitsInsidePrism > 0. GetNumberOfHitsInsidePrism counts the number of hits inside the volume.
  • nInsidePrismVolume: Number of hits of the event registered inside the volume.
  • energyInsidePrismVolume: Total energy of the hits deposited inside the volume.
  • xMeanInPrism: For all energy depositions inside the prism fiducial volume it takes the mean position in X coordinate using the energies as weights.
  • yMeanInPrism: For all energy depositions inside the prism fiducial volume it takes the mean position in Y coordinate using the energies as weights.
  • zMeanInPrism: For all energy depositions inside the prism fiducial volume it takes the mean position in Z coordinate using the energies as weights.

Distance to the borders of the volume (cylinder or prism):

  • distanceToCylinderWall: Distance from the closest hit of the event to the cylinder wall. Only hits inside the cylinder.
  • distanceToCylinderTop: Distance from the closest hit of the event to the top of the cylinder. Only hits inside the cylinder.
  • distanceToCylinderBottom: Distance from the closest hit of the event to the bottom of the cylinder. Only hits inside the cylinder.
  • distanceToPrismWall: Distance from the closest hit of the event to the wall of the prism. Only hits inside the prism.
  • distanceToPrismTop: Distance from the closest hit of the event to the top of the prism. Only hits inside the prism.
  • distanceToPrismBottom: Distance from the closest hit of the event to the bottom of the prism. Only hits inside the prism.

Energy properties:

  • energy: Total energy deposited in all the hits of the event (fTotEnergy).
  • energyX: Total energy deposited in hits with X coordinate well defined (!IsNaN(fX[n])).
  • energyY: Total energy deposited in hits with Y coordinate well defined (!IsNaN(fY[n])).
  • balanceXYenergy: (energyX - energyY) / (energyX + energyY).
  • maxHitEnergy: Maximum energy of a hit in the event.
  • minHitEnergy: Minimum energy of a hit in the event.
  • meanHitEnergy: Total energy / Number of hits.
  • meanHitEnergyBalance: meanHitEnergy / energy.

Position statistics (mean, variance, skewness):

  • xMean: Coordinate X of the mean position of the hits of the event weighted with their energies. SUM(E_n x_n)/E_T .
  • yMean: Coordinate Y of the mean position of the hits of the event weighted with their energies. SUM(E_n y_n)/E_T .
  • zMean: Coordinate Z of the mean position of the hits of the event weighted with their energies. SUM(E_n z_n)/E_T .
  • xy2Sigma: Sum of the variance in coordinates X and Y in the hits of an event. s_xy^2=SUM(E_n[(m_x-x_n)^2+(m_y-y_n)^2])/E_T =s_x^2+s_y^2.
  • xySigmaBalance: (s_x-s_y)/(s_x+s_y).
  • z2Sigma: Variance in Z in the hits of an event, s_z^2=SUM(E_n (m_z-z_n )^2)/E_T .
  • xySkew: s_xy=SUM(E_n [(m_x-x_n)^3+(m_y-y_n)^3])/(E_T x s_xy^3).
  • zSkew: skew=SUM(E_n (m_z-z_n)^3)/(E_T x s_z^3) Fisher-Pearson coefficient of skewness, third central moment divided by the standard deviation to the power three. It measures the asymmetry of the distribution.

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2016-May: First implementation of hits analysis process into REST_v2.

Author
Javier Galan

Definition at line 35 of file TRestDetectorHitsAnalysisProcess.h.

#include <TRestDetectorHitsAnalysisProcess.h>

Inheritance diagram for TRestDetectorHitsAnalysisProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestDetectorHitsAnalysisProcess, 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.
TRestEvent * ProcessEvent (TRestEvent *inputEvent) override
 Process one event.
 TRestDetectorHitsAnalysisProcess (const char *configFilename)
Public Member Functions inherited from TRestEventProcess
virtual Bool_t AddInputFile (const std::string &file)
bool ApplyCut ()
 Apply cut according to the cut conditions saved in fCut.
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().
TRestAnalysisTree * GetAnalysisTree () const
 Return the local analysis tree (dummy).
TCanvas * GetCanvas () const
 Get canvas.
TRestAnalysisTree * GetFullAnalysisTree ()
 Get the full analysis tree from TRestRun, with non-empty entries.
std::vector< std::string > GetListOfAddedObservables ()
 Get list of observables, convert map to vector.
TRestRun * GetRunInfo () 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
 Load extra section metadata: outputlevel after calling TRestMetadata::LoadSectionMetadata().
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)
 Interface to external file reading, open input file. To be implemented in external processes.
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 fFid_R
Double_t fFid_sX
Double_t fFid_sY
Double_t fFid_theta
TVector3 fFid_x0
TVector3 fFid_x1
Protected Attributes inherited from TRestEventProcess
TRestAnalysisTree * fAnalysisTree = 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.
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.
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
TRestRun * fRunInfo = 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 fCylinderFiducial
TRestDetectorHitsEvent * fInputHitsEvent
TRestDetectorHitsEvent * fOutputHitsEvent
Bool_t fPrismFiducial

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 ()
 Pre-defined printer, can be used at the ending in the implementation of PrintMetadata().
TRestEventProcess * GetFriend (const std::string &nameOrType)
 Get friendly TRestEventProcess object.
TRestEventProcess * GetFriendLive (const std::string &nameOrType)
 Get friendly TRestEventProcess object.
template<class T>
T * GetMetadata ()
 Get a metadata object from the host TRestRun.
TRestMetadata * GetMetadata (const std::string &nameOrType)
 Get a metadata object from the host TRestRun.
size_t GetNumberOfParallelProcesses () const
template<class T>
T GetObservableValue (const std::string &name)
TRestEventProcess * GetParallel (int i)
 Get a list of parallel processes from this process.
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.
template<class T>
void SetObservableValue (const std::string &name, const T &value)
 Set observable value for AnalysisTree.

Constructor & Destructor Documentation

◆ TRestDetectorHitsAnalysisProcess() [1/2]

TRestDetectorHitsAnalysisProcess::TRestDetectorHitsAnalysisProcess ( )

Definition at line 129 of file TRestDetectorHitsAnalysisProcess.cxx.

◆ TRestDetectorHitsAnalysisProcess() [2/2]

TRestDetectorHitsAnalysisProcess::TRestDetectorHitsAnalysisProcess ( const char * configFilename)

Definition at line 131 of file TRestDetectorHitsAnalysisProcess.cxx.

◆ ~TRestDetectorHitsAnalysisProcess()

TRestDetectorHitsAnalysisProcess::~TRestDetectorHitsAnalysisProcess ( )

Definition at line 138 of file TRestDetectorHitsAnalysisProcess.cxx.

Member Function Documentation

◆ EndProcess()

void TRestDetectorHitsAnalysisProcess::EndProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 356 of file TRestDetectorHitsAnalysisProcess.cxx.

◆ GetInputEvent()

RESTValue TRestDetectorHitsAnalysisProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 60 of file TRestDetectorHitsAnalysisProcess.h.

◆ GetOutputEvent()

RESTValue TRestDetectorHitsAnalysisProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 61 of file TRestDetectorHitsAnalysisProcess.h.

◆ GetProcessName()

const char * TRestDetectorHitsAnalysisProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 90 of file TRestDetectorHitsAnalysisProcess.h.

◆ InitFromConfigFile()

void TRestDetectorHitsAnalysisProcess::InitFromConfigFile ( )
overrideprivatevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 365 of file TRestDetectorHitsAnalysisProcess.cxx.

◆ Initialize()

void TRestDetectorHitsAnalysisProcess::Initialize ( )
overrideprivatevirtual

Making default settings.

Reimplemented from TRestMetadata.

Definition at line 142 of file TRestDetectorHitsAnalysisProcess.cxx.

◆ InitProcess()

void TRestDetectorHitsAnalysisProcess::InitProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 157 of file TRestDetectorHitsAnalysisProcess.cxx.

◆ LoadConfig()

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

Definition at line 153 of file TRestDetectorHitsAnalysisProcess.cxx.

◆ LoadDefaultConfig()

void TRestDetectorHitsAnalysisProcess::LoadDefaultConfig ( )
private

Definition at line 140 of file TRestDetectorHitsAnalysisProcess.cxx.

◆ PrintMetadata()

void TRestDetectorHitsAnalysisProcess::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 69 of file TRestDetectorHitsAnalysisProcess.h.

◆ ProcessEvent()

TRestEvent * TRestDetectorHitsAnalysisProcess::ProcessEvent ( TRestEvent * inputEvent)
overridevirtual

Process one event.

Implements TRestEventProcess.

Definition at line 159 of file TRestDetectorHitsAnalysisProcess.cxx.

Field Documentation

◆ fCylinderFiducial

Bool_t TRestDetectorHitsAnalysisProcess::fCylinderFiducial
private

Definition at line 40 of file TRestDetectorHitsAnalysisProcess.h.

◆ fFid_R

Double_t TRestDetectorHitsAnalysisProcess::fFid_R
protected

Definition at line 54 of file TRestDetectorHitsAnalysisProcess.h.

◆ fFid_sX

Double_t TRestDetectorHitsAnalysisProcess::fFid_sX
protected

Definition at line 55 of file TRestDetectorHitsAnalysisProcess.h.

◆ fFid_sY

Double_t TRestDetectorHitsAnalysisProcess::fFid_sY
protected

Definition at line 56 of file TRestDetectorHitsAnalysisProcess.h.

◆ fFid_theta

Double_t TRestDetectorHitsAnalysisProcess::fFid_theta
protected

Definition at line 57 of file TRestDetectorHitsAnalysisProcess.h.

◆ fFid_x0

TVector3 TRestDetectorHitsAnalysisProcess::fFid_x0
protected

Definition at line 52 of file TRestDetectorHitsAnalysisProcess.h.

◆ fFid_x1

TVector3 TRestDetectorHitsAnalysisProcess::fFid_x1
protected

Definition at line 53 of file TRestDetectorHitsAnalysisProcess.h.

◆ fInputHitsEvent

TRestDetectorHitsEvent* TRestDetectorHitsAnalysisProcess::fInputHitsEvent
private

Definition at line 37 of file TRestDetectorHitsAnalysisProcess.h.

◆ fOutputHitsEvent

TRestDetectorHitsEvent* TRestDetectorHitsAnalysisProcess::fOutputHitsEvent
private

Definition at line 38 of file TRestDetectorHitsAnalysisProcess.h.

◆ fPrismFiducial

Bool_t TRestDetectorHitsAnalysisProcess::fPrismFiducial
private

Definition at line 41 of file TRestDetectorHitsAnalysisProcess.h.


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