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

Detailed Description

An event data class to define the parameters related to an axion particle.

TRestAxionEvent is an event class used to define the properties of an axion particle.

TODO. Create an appropriate documentation here (if needed).


RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2019-March: First concept and implementation of TRestAxionEvent class. Javier Galan

Author
Javier Galan

Definition at line 35 of file TRestAxionEvent.h.

#include <TRestAxionEvent.h>

Inheritance diagram for TRestAxionEvent:
TRestEvent

Public Member Functions

TPad * DrawEvent (TString option="")
 
TVector3 GetDirection ()
 
Double_t GetDirectionX ()
 
Double_t GetDirectionY ()
 
Double_t GetDirectionZ ()
 
Double_t GetEnergy ()
 
Double_t GetMass ()
 
Double_t GetMassIneV ()
 
TVector3 GetPosition ()
 It keeps track of efficiency introduced at different helioscope components.
 
Double_t GetPositionX ()
 
Double_t GetPositionY ()
 
Double_t GetPositionZ ()
 
virtual void Initialize ()
 
virtual void PrintEvent ()
 
void RotateXY (const TVector3 &center, Double_t pitch, Double_t yaw)
 This method will produce a rotation respect to a center given by argument. First we rotate the particle and direction along the X-axis by an angle pitch, then we rotate the particle and direction along the Y-axis by an angle yaw.
 
void RotateXZ (const TVector3 &center, Double_t theta, Double_t phi)
 This method will produce a rotation respect to a center given by argument. First we rotate the particle and direction along the X-axis by an angle theta, then we rotate the particle and direction along the Z-axis by an angle phi.
 
void RotateYX (const TVector3 &center, Double_t yaw, Double_t pitch)
 This method will produce a rotation respect to a center given by argument. First we rotate the particle and direction along the Y-axis by an angle yaw, then we rotate the particle and direction along the X-axis by an angle pitch.
 
void RotateZX (const TVector3 &center, Double_t phi, Double_t theta)
 This method will produce a rotation respect to a center given by argument. First we rotate the particle and direction along the Z-axis by an angle phi, then we rotate the particle and direction along the X-axis by an angle theta.
 
void SetDirection (Double_t px, Double_t py, Double_t pz)
 
void SetDirection (TVector3 dir)
 
void SetEnergy (Double_t en)
 
void SetMass (Double_t m)
 
void SetPosition (Double_t x, Double_t y, Double_t z)
 
void SetPosition (TVector3 pos)
 
void Translate (const TVector3 &delta)
 This method will produce a tranlation of the axion position by an amount delta.
 
- Public Member Functions inherited from TRestEvent
virtual void CloneTo (TRestEvent *target)
 Clone the content of this TRestEvent object to another. More...
 
virtual TPad * DrawEvent (const TString &option="")
 Draw the event. More...
 
Int_t GetID () const
 
Int_t GetRunOrigin () const
 
TString GetSubEventTag () const
 
Int_t GetSubID () const
 
Int_t GetSubRunOrigin () const
 
Double_t GetTime () const
 
TTimeStamp GetTimeStamp () const
 
virtual void InitializeReferences (TRestRun *run)
 Initialize dynamical references when loading the event from a root file. More...
 
virtual void InitializeWithMetadata (TRestRun *run)
 
Bool_t isOk () const
 
virtual void PrintEvent () const
 
void SetEventInfo (TRestEvent *eve)
 
void SetID (Int_t id)
 
void SetOK (Bool_t state)
 
void SetRunOrigin (Int_t run_origin)
 
void SetState (Bool_t state)
 
void SetSubEventTag (const TString &tag)
 
void SetSubID (Int_t id)
 
void SetSubRunOrigin (Int_t sub_run_origin)
 
void SetTime (Double_t seconds, Double_t nanoseconds)
 
void SetTime (Double_t time)
 
void SetTimeStamp (const TTimeStamp &time)
 
 TRestEvent ()
 
virtual ~TRestEvent ()
 

Private Attributes

TVector3 fDirection
 Particle momentum. Unitary direction.
 
Double_t fEnergy = 0
 Initial energy of the axion.
 
Double_t fMass = 0.
 Axion mass in keV.
 
TVector3 fPosition
 Particle position.
 

Additional Inherited Members

- Protected Member Functions inherited from TRestEvent
void RestartPad (Int_t nElements)
 
- Protected Attributes inherited from TRestEvent
Int_t fEventID
 Event identification number.
 
TTimeStamp fEventTime
 Absolute event time.
 
Bool_t fOk
 Flag to be used by processes to define an event status. fOk=true is the default.
 
TPad * fPad
 
TRestRunfRun = nullptr
 
Int_t fRunOrigin
 Run ID number of the event.
 
Int_t fSubEventID
 Sub-Event identification number.
 
TString fSubEventTag
 A short length label to identify the sub-Event.
 
Int_t fSubRunOrigin
 Sub-run ID number of the event.
 

Member Function Documentation

◆ Initialize()

void TRestAxionEvent::Initialize ( )
virtual

Run to initialize event data. To be re-implemented in derived class, you may want to call the base class at the end of the re-implemented, by calling TRestEvent::Initialize();

Implements TRestEvent.

Definition at line 59 of file TRestAxionEvent.cxx.


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