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

Detailed Description




         RESTSoft : Software for Rare Event Searches with TPCs

         TRestDetectorHitsRotateAndTranslateProcess.h

         march 2016:   First concept
             Created as part of the conceptualization of existing REST
             software.
             Javier G. Garza

Definition at line 24 of file TRestDetectorHitsRotateAndTranslateProcess.h.

#include <TRestDetectorHitsRotateAndTranslateProcess.h>

Inheritance diagram for TRestDetectorHitsRotateAndTranslateProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestDetectorHitsRotateAndTranslateProcess, 1)
 
void EndProcess () override
 To be executed at the end of the run (outside event loop) More...
 
Double_t GetAlpha () const
 
Double_t GetBeta () const
 
Double_t GetDeltaX () const
 
Double_t GetDeltaY () const
 
Double_t GetDeltaZ () const
 
Double_t GetGamma () const
 
any GetInputEvent () const override
 Get pointer to input event. Must be implemented in the derived class. More...
 
any 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 (std::string configFilename)
 
void PrintMetadata () override
 Implemented it in the derived metadata class to print out specific metadata information. More...
 
TRestEvent * ProcessEvent (TRestEvent *inputEvent) override
 Process one event. More...
 
 TRestDetectorHitsRotateAndTranslateProcess (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...
 
TRestAnalysisTree * GetAnalysisTree () const
 Return the local analysis tree (dummy) More...
 
TCanvas * GetCanvas () const
 Get canvas. More...
 
TRestAnalysisTree * GetFullAnalysisTree ()
 
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
 
TRestRun * GetRunInfo () 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 TRestEvent * ProcessEvent (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

Double_t fAlpha
 rotation angle around z-axis More...
 
Double_t fBeta
 rotation angle around y-axis More...
 
Double_t fDeltaX
 shift in X-axis More...
 
Double_t fDeltaY
 shift in X-axis More...
 
Double_t fDeltaZ
 shift in X-axis More...
 
Double_t fGamma
 rotation angle around x-axis More...
 
TRestDetectorHitsEvent * fInputHitsEvent
 
TRestDetectorHitsEvent * fOutputHitsEvent
 

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 ()
 
TRestEventProcess * GetFriend (const std::string &nameOrType)
 
TRestEventProcess * GetFriendLive (const std::string &nameOrType)
 
template<class T >
T * GetMetadata ()
 Get a metadata object from the host TRestRun. More...
 
TRestMetadata * GetMetadata (const std::string &nameOrType)
 
size_t GetNumberOfParallelProcesses () const
 
template<class T >
T GetObservableValue (const std::string &name)
 
TRestEventProcess * GetParallel (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
TRestAnalysisTree * fAnalysisTree = 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...
 
TRestRun * fRunInfo = 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

◆ TRestDetectorHitsRotateAndTranslateProcess() [1/2]

TRestDetectorHitsRotateAndTranslateProcess::TRestDetectorHitsRotateAndTranslateProcess ( )

◆ TRestDetectorHitsRotateAndTranslateProcess() [2/2]

TRestDetectorHitsRotateAndTranslateProcess::TRestDetectorHitsRotateAndTranslateProcess ( const char *  configFilename)

◆ ~TRestDetectorHitsRotateAndTranslateProcess()

TRestDetectorHitsRotateAndTranslateProcess::~TRestDetectorHitsRotateAndTranslateProcess ( )

Member Function Documentation

◆ EndProcess()

void TRestDetectorHitsRotateAndTranslateProcess::EndProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 106 of file TRestDetectorHitsRotateAndTranslateProcess.cxx.

◆ GetAlpha()

Double_t TRestDetectorHitsRotateAndTranslateProcess::GetAlpha ( ) const
inline

Definition at line 73 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ GetBeta()

Double_t TRestDetectorHitsRotateAndTranslateProcess::GetBeta ( ) const
inline

Definition at line 74 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ GetDeltaX()

Double_t TRestDetectorHitsRotateAndTranslateProcess::GetDeltaX ( ) const
inline

Definition at line 69 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ GetDeltaY()

Double_t TRestDetectorHitsRotateAndTranslateProcess::GetDeltaY ( ) const
inline

Definition at line 70 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ GetDeltaZ()

Double_t TRestDetectorHitsRotateAndTranslateProcess::GetDeltaZ ( ) const
inline

Definition at line 71 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ GetGamma()

Double_t TRestDetectorHitsRotateAndTranslateProcess::GetGamma ( ) const
inline

Definition at line 75 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ GetInputEvent()

any TRestDetectorHitsRotateAndTranslateProcess::GetInputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 45 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ GetOutputEvent()

any TRestDetectorHitsRotateAndTranslateProcess::GetOutputEvent ( ) const
inlineoverridevirtual

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

Implements TRestEventProcess.

Definition at line 46 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ GetProcessName()

const char * TRestDetectorHitsRotateAndTranslateProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 67 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ InitFromConfigFile()

void TRestDetectorHitsRotateAndTranslateProcess::InitFromConfigFile ( )
overrideprivatevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 115 of file TRestDetectorHitsRotateAndTranslateProcess.cxx.

◆ Initialize()

void TRestDetectorHitsRotateAndTranslateProcess::Initialize ( )
overrideprivatevirtual

Making default settings.

Reimplemented from TRestMetadata.

Definition at line 58 of file TRestDetectorHitsRotateAndTranslateProcess.cxx.

◆ InitProcess()

void TRestDetectorHitsRotateAndTranslateProcess::InitProcess ( )
overridevirtual

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

Reimplemented from TRestEventProcess.

Definition at line 79 of file TRestDetectorHitsRotateAndTranslateProcess.cxx.

◆ LoadConfig()

void TRestDetectorHitsRotateAndTranslateProcess::LoadConfig ( std::string  configFilename)

◆ LoadDefaultConfig()

void TRestDetectorHitsRotateAndTranslateProcess::LoadDefaultConfig ( )
private

◆ PrintMetadata()

void TRestDetectorHitsRotateAndTranslateProcess::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 54 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ ProcessEvent()

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

Process one event.

Implements TRestEventProcess.

Definition at line 88 of file TRestDetectorHitsRotateAndTranslateProcess.cxx.

Field Documentation

◆ fAlpha

Double_t TRestDetectorHitsRotateAndTranslateProcess::fAlpha
private

rotation angle around z-axis

Definition at line 33 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ fBeta

Double_t TRestDetectorHitsRotateAndTranslateProcess::fBeta
private

rotation angle around y-axis

Definition at line 34 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ fDeltaX

Double_t TRestDetectorHitsRotateAndTranslateProcess::fDeltaX
private

shift in X-axis

Definition at line 29 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ fDeltaY

Double_t TRestDetectorHitsRotateAndTranslateProcess::fDeltaY
private

shift in X-axis

Definition at line 30 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ fDeltaZ

Double_t TRestDetectorHitsRotateAndTranslateProcess::fDeltaZ
private

shift in X-axis

Definition at line 31 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ fGamma

Double_t TRestDetectorHitsRotateAndTranslateProcess::fGamma
private

rotation angle around x-axis

Definition at line 35 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ fInputHitsEvent

TRestDetectorHitsEvent* TRestDetectorHitsRotateAndTranslateProcess::fInputHitsEvent
private

Definition at line 26 of file TRestDetectorHitsRotateAndTranslateProcess.h.

◆ fOutputHitsEvent

TRestDetectorHitsEvent* TRestDetectorHitsRotateAndTranslateProcess::fOutputHitsEvent
private

Definition at line 27 of file TRestDetectorHitsRotateAndTranslateProcess.h.


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