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:

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

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

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

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

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

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

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	Initialize ()=0

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

Double_t	fEnergy = 0
	Initial energy of the axion. More...

Double_t	fMass = 0.
	Axion mass in keV. More...

TVector3	fPosition
	Particle position. More...

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

TTimeStamp	fEventTime
	Absolute event time. More...

Bool_t	fOk
	Flag to be used by processes to define an event status. fOk=true is the default. More...

TPad *	fPad

TRestRun *	fRun = nullptr

Int_t	fRunOrigin
	Run ID number of the event. More...

Int_t	fSubEventID
	Sub-Event identification number. More...

TString	fSubEventTag
	A short length label to identify the sub-Event. More...

Int_t	fSubRunOrigin
	Sub-run ID number of the event. More...

Constructor & Destructor Documentation

◆ TRestAxionEvent()

TRestAxionEvent::TRestAxionEvent ( )

Definition at line 52 of file TRestAxionEvent.cxx.

◆ ~TRestAxionEvent()

TRestAxionEvent::~TRestAxionEvent ( )

Definition at line 57 of file TRestAxionEvent.cxx.

Member Function Documentation

◆ DrawEvent()

TPad * TRestAxionEvent::DrawEvent ( TString option = "" )

Definition at line 61 of file TRestAxionEvent.cxx.

◆ GetDirection()

TVector3 TRestAxionEvent::GetDirection ( )

inline

Definition at line 60 of file TRestAxionEvent.h.

◆ GetDirectionX()

Double_t TRestAxionEvent::GetDirectionX ( )

inline

Definition at line 62 of file TRestAxionEvent.h.

◆ GetDirectionY()

Double_t TRestAxionEvent::GetDirectionY ( )

inline

Definition at line 63 of file TRestAxionEvent.h.

◆ GetDirectionZ()

Double_t TRestAxionEvent::GetDirectionZ ( )

inline

Definition at line 64 of file TRestAxionEvent.h.

◆ GetEnergy()

Double_t TRestAxionEvent::GetEnergy ( )

inline

Definition at line 66 of file TRestAxionEvent.h.

◆ GetMass()

Double_t TRestAxionEvent::GetMass ( )

inline

Definition at line 67 of file TRestAxionEvent.h.

◆ GetMassIneV()

Double_t TRestAxionEvent::GetMassIneV ( )

inline

Definition at line 68 of file TRestAxionEvent.h.

◆ GetPosition()

TVector3 TRestAxionEvent::GetPosition ( )

inline

It keeps track of efficiency introduced at different helioscope components.

Definition at line 54 of file TRestAxionEvent.h.

◆ GetPositionX()

Double_t TRestAxionEvent::GetPositionX ( )

inline

Definition at line 56 of file TRestAxionEvent.h.

◆ GetPositionY()

Double_t TRestAxionEvent::GetPositionY ( )

inline

Definition at line 57 of file TRestAxionEvent.h.

◆ GetPositionZ()

Double_t TRestAxionEvent::GetPositionZ ( )

inline

Definition at line 58 of file TRestAxionEvent.h.

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

◆ PrintEvent()

void TRestAxionEvent::PrintEvent ( )

virtual

Definition at line 159 of file TRestAxionEvent.cxx.

◆ RotateXY()

void TRestAxionEvent::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.

Definition at line 125 of file TRestAxionEvent.cxx.

◆ RotateXZ()

void TRestAxionEvent::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.

Definition at line 91 of file TRestAxionEvent.cxx.

◆ RotateYX()

void TRestAxionEvent::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.

Definition at line 142 of file TRestAxionEvent.cxx.

◆ RotateZX()

void TRestAxionEvent::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.

Definition at line 108 of file TRestAxionEvent.cxx.

◆ SetDirection() [1/2]

void TRestAxionEvent::SetDirection	(	Double_t	px,
		Double_t	py,
		Double_t	pz
	)

inline

Definition at line 78 of file TRestAxionEvent.h.

◆ SetDirection() [2/2]

void TRestAxionEvent::SetDirection ( TVector3 dir )

inline

Definition at line 77 of file TRestAxionEvent.h.

◆ SetEnergy()

void TRestAxionEvent::SetEnergy ( Double_t en )

inline

Definition at line 86 of file TRestAxionEvent.h.

◆ SetMass()

void TRestAxionEvent::SetMass ( Double_t m )

inline

Definition at line 87 of file TRestAxionEvent.h.

◆ SetPosition() [1/2]

void TRestAxionEvent::SetPosition	(	Double_t	x,
		Double_t	y,
		Double_t	z
	)

inline

Definition at line 73 of file TRestAxionEvent.h.

◆ SetPosition() [2/2]

void TRestAxionEvent::SetPosition ( TVector3 pos )

inline

Definition at line 72 of file TRestAxionEvent.h.

◆ Translate()

void TRestAxionEvent::Translate ( const TVector3 & delta )

This method will produce a tranlation of the axion position by an amount delta.

Definition at line 157 of file TRestAxionEvent.cxx.

Field Documentation

◆ fDirection

TVector3 TRestAxionEvent::fDirection

private

Particle momentum. Unitary direction.

Definition at line 41 of file TRestAxionEvent.h.

◆ fEnergy

Double_t TRestAxionEvent::fEnergy = 0

private

Initial energy of the axion.

Definition at line 44 of file TRestAxionEvent.h.

◆ fMass

Double_t TRestAxionEvent::fMass = 0.

private

Axion mass in keV.

Definition at line 47 of file TRestAxionEvent.h.

◆ fPosition

TVector3 TRestAxionEvent::fPosition

private

Particle position.

Definition at line 38 of file TRestAxionEvent.h.

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

Detailed Description

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRestAxionEvent()

◆ ~TRestAxionEvent()

Member Function Documentation

◆ DrawEvent()

◆ GetDirection()

◆ GetDirectionX()

◆ GetDirectionY()

◆ GetDirectionZ()

◆ GetEnergy()

◆ GetMass()

◆ GetMassIneV()

◆ GetPosition()

◆ GetPositionX()

◆ GetPositionY()

◆ GetPositionZ()

◆ Initialize()

◆ PrintEvent()

◆ RotateXY()

◆ RotateXZ()

◆ RotateYX()

◆ RotateZX()

◆ SetDirection() [1/2]

◆ SetDirection() [2/2]

◆ SetEnergy()

◆ SetMass()

◆ SetPosition() [1/2]

◆ SetPosition() [2/2]

◆ Translate()

Field Documentation

◆ fDirection

◆ fEnergy

◆ fMass

◆ fPosition