GammaLib  1.7.0.dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GCOMEventAtom Class Reference

COMPTEL event atom class. More...

#include <GCOMEventAtom.hpp>

Inheritance diagram for GCOMEventAtom:
GEventAtom GEvent GBase

Public Member Functions

 GCOMEventAtom (void)
 Void constructor. More...
 
 GCOMEventAtom (const GCOMEventAtom &atom)
 Copy constructor. More...
 
virtual ~GCOMEventAtom (void)
 Destructor. More...
 
GCOMEventAtomoperator= (const GCOMEventAtom &atom)
 Assignment operator. More...
 
void clear (void)
 Clear event atom. More...
 
GCOMEventAtomclone (void) const
 Clone event atom. More...
 
std::string classname (void) const
 Return class name. More...
 
const GCOMInstDirdir (void) const
 Return event instrument direction. More...
 
const GEnergyenergy (void) const
 Return event energy. More...
 
const GTimetime (void) const
 Return event time. More...
 
std::string print (const GChatter &chatter=NORMAL) const
 Print event information. More...
 
void dir (const GCOMInstDir &dir)
 Set event instrument direction. More...
 
void energy (const GEnergy &energy)
 Set event energy. More...
 
void time (const GTime &time)
 Set event time. More...
 
void time (const int &tjd, const int &tics)
 Set event time. More...
 
void phibar (const float &phibar)
 Set Compton scatter angle. More...
 
const float & phibar (void) const
 Return Compton scatter angle. More...
 
void phi (const float &phi)
 Set scatter azimuth angle. More...
 
const float & phi (void) const
 Return scatter azimuth angle. More...
 
void theta (const float &theta)
 Set scatter zenith angle. More...
 
const float & theta (void) const
 Return scatter zenith angle. More...
 
void eha (const float &eha)
 Set Earth horizon angle. More...
 
const float & eha (void) const
 Return Earth horizon angle. More...
 
void e1 (const float &e1)
 Set D1 module energy deposit. More...
 
const float & e1 (void) const
 Return D1 module energy deposit. More...
 
void e2 (const float &e2)
 Set D2 module energy deposit. More...
 
const float & e2 (void) const
 Return D2 module energy deposit. More...
 
void psd (const float &psd)
 Set PSD value. More...
 
const float & psd (void) const
 Return PSD value. More...
 
void tof (const float &tof)
 Set TOF value. More...
 
const float & tof (void) const
 Return TOF value. More...
 
void modcom (const int &modcom)
 Set mini telescope. More...
 
const int & modcom (void) const
 Return mini telescope. More...
 
void reflag (const int &reflag)
 Set rejection flag. More...
 
const int & reflag (void) const
 Return rejection flag. More...
 
void veto (const int &veto)
 Set veto flag. More...
 
const int & veto (void) const
 Return veto flag. More...
 
- Public Member Functions inherited from GEventAtom
 GEventAtom (void)
 Void constructor. More...
 
 GEventAtom (const GEventAtom &atom)
 Copy constructor. More...
 
virtual ~GEventAtom (void)
 Destructor. More...
 
virtual GEventAtomoperator= (const GEventAtom &atom)
 Assignment operator. More...
 
virtual double size (void) const
 Return size of an event atom. More...
 
virtual double counts (void) const
 Return number of counts in event atom. More...
 
virtual double error (void) const
 Return error in number of counts in event atom. More...
 
bool is_atom (void) const
 Signal if event is an atom. More...
 
bool is_bin (void) const
 Signal if event is a bin. More...
 
- Public Member Functions inherited from GEvent
 GEvent (void)
 Void constructor. More...
 
 GEvent (const GEvent &event)
 Copy constructor. More...
 
virtual ~GEvent (void)
 Destructor. More...
 
virtual GEventoperator= (const GEvent &event)
 Assignment operator. More...
 
- Public Member Functions inherited from GBase
virtual ~GBase (void)
 Destructor. More...
 

Protected Member Functions

void init_members (void)
 Initialise class members. More...
 
void copy_members (const GCOMEventAtom &atom)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
- Protected Member Functions inherited from GEventAtom
void init_members (void)
 Initialise class members. More...
 
void copy_members (const GEventAtom &atom)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
- Protected Member Functions inherited from GEvent
void init_members (void)
 Initialise class members. More...
 
void copy_members (const GEvent &event)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 

Protected Attributes

GCOMInstDir m_dir
 Event direction. More...
 
GEnergy m_energy
 Event energy. More...
 
GTime m_time
 Event time. More...
 
float m_e1
 D1 energy deposit (MeV) More...
 
float m_e2
 D2 energy deposit (MeV) More...
 
float m_phibar
 Compton scatter angle (deg) More...
 
float m_theta
 Zenith angle of scatter direction (deg) More...
 
float m_phi
 Azimuth angle of scatter direction (deg) More...
 
float m_eha
 Earth horizon angle (deg) More...
 
float m_psd
 PSD value (channel) More...
 
float m_tof
 Time of flight value (channel) More...
 
int m_modcom
 Mini telescope number. More...
 
int m_reflag
 Rejection flag. More...
 
int m_veto
 Veto flag. More...
 

Detailed Description

COMPTEL event atom class.

Definition at line 45 of file GCOMEventAtom.hpp.

Constructor & Destructor Documentation

GCOMEventAtom::GCOMEventAtom ( void  )

Void constructor.

Creates an empty COMPTEL event atom.

Definition at line 55 of file GCOMEventAtom.cpp.

References init_members().

Referenced by clone().

GCOMEventAtom::GCOMEventAtom ( const GCOMEventAtom atom)

Copy constructor.

Parameters
[in]atomCOMPTEL event atom.

Definition at line 70 of file GCOMEventAtom.cpp.

References copy_members(), and init_members().

GCOMEventAtom::~GCOMEventAtom ( void  )
virtual

Destructor.

Definition at line 86 of file GCOMEventAtom.cpp.

References free_members().

Member Function Documentation

std::string GCOMEventAtom::classname ( void  ) const
inlinevirtual

Return class name.

Returns
String containing the class name ("GCOMEventAtom").

Implements GEventAtom.

Definition at line 123 of file GCOMEventAtom.hpp.

void GCOMEventAtom::clear ( void  )
virtual

Clear event atom.

Clears COMPTEL event atom by resetting all class members to an initial state. Any information that was present before will be lost.

Implements GEventAtom.

Definition at line 144 of file GCOMEventAtom.cpp.

References GEventAtom::free_members(), free_members(), GEvent::free_members(), GEventAtom::init_members(), init_members(), and GEvent::init_members().

GCOMEventAtom * GCOMEventAtom::clone ( void  ) const
virtual

Clone event atom.

Returns
Pointer to deep copy of COMPTEL event atom.

Implements GEventAtom.

Definition at line 166 of file GCOMEventAtom.cpp.

References GCOMEventAtom().

void GCOMEventAtom::copy_members ( const GCOMEventAtom atom)
protected

Copy class members.

Parameters
[in]atomCOMPTEL event atom.

Definition at line 255 of file GCOMEventAtom.cpp.

References m_dir, m_e1, m_e2, m_eha, m_energy, m_modcom, m_phi, m_phibar, m_psd, m_reflag, m_theta, m_time, m_tof, and m_veto.

Referenced by GCOMEventAtom(), and operator=().

const GCOMInstDir & GCOMEventAtom::dir ( void  ) const
inlinevirtual

Return event instrument direction.

Returns
Event instrument direction.

Returns the direction of the event.

Implements GEventAtom.

Definition at line 137 of file GCOMEventAtom.hpp.

References m_dir.

Referenced by dir().

void GCOMEventAtom::dir ( const GCOMInstDir dir)
inline

Set event instrument direction.

Parameters
[in]dirEvent instrument direction.

Sets the event instrument direction.

Definition at line 151 of file GCOMEventAtom.hpp.

References dir(), and m_dir.

void GCOMEventAtom::e1 ( const float &  e1)
inline

Set D1 module energy deposit.

Parameters
[in]e1D1 module energy deposit (MeV).

Sets D1 module energy deposit.

Definition at line 340 of file GCOMEventAtom.hpp.

References e1(), and m_e1.

Referenced by GCOMSelection::use_event().

const float & GCOMEventAtom::e1 ( void  ) const
inline

Return D1 module energy deposit.

Returns
D1 module energy deposit (MeV).

Returns D1 module energy deposit.

Definition at line 355 of file GCOMEventAtom.hpp.

References m_e1.

Referenced by e1().

void GCOMEventAtom::e2 ( const float &  e2)
inline

Set D2 module energy deposit.

Parameters
[in]e2D2 module energy deposit (MeV).

Sets D2 module energy deposit.

Definition at line 369 of file GCOMEventAtom.hpp.

References e2(), and m_e2.

Referenced by GCOMSelection::use_event().

const float & GCOMEventAtom::e2 ( void  ) const
inline

Return D2 module energy deposit.

Returns
D2 module energy deposit (MeV).

Returns D2 module energy deposit.

Definition at line 384 of file GCOMEventAtom.hpp.

References m_e2.

Referenced by e2().

void GCOMEventAtom::eha ( const float &  eha)
inline

Set Earth horizon angle.

Parameters
[in]ehaEarth horizon angle (deg).

Sets Earth horizon angle.

Definition at line 311 of file GCOMEventAtom.hpp.

References eha(), and m_eha.

const float & GCOMEventAtom::eha ( void  ) const
inline

Return Earth horizon angle.

Returns
Earth horizon angle (deg).

Returns Earth horizon angle.

Definition at line 326 of file GCOMEventAtom.hpp.

References m_eha.

Referenced by eha().

const GEnergy & GCOMEventAtom::energy ( void  ) const
inlinevirtual

Return event energy.

Returns
Event energy.

Returns the reconstructed energy of the photon on the sky.

Implements GEventAtom.

Definition at line 166 of file GCOMEventAtom.hpp.

References m_energy.

Referenced by energy().

void GCOMEventAtom::energy ( const GEnergy energy)
inline

Set event energy.

Parameters
[in]energyEvent energy.

Sets the event energy.

Definition at line 180 of file GCOMEventAtom.hpp.

References energy(), and m_energy.

void GCOMEventAtom::free_members ( void  )
protected

Delete class members.

Definition at line 281 of file GCOMEventAtom.cpp.

Referenced by clear(), operator=(), and ~GCOMEventAtom().

void GCOMEventAtom::init_members ( void  )
protected

Initialise class members.

Definition at line 227 of file GCOMEventAtom.cpp.

References GCOMInstDir::clear(), GEnergy::clear(), GTime::clear(), m_dir, m_e1, m_e2, m_eha, m_energy, m_modcom, m_phi, m_phibar, m_psd, m_reflag, m_theta, m_time, m_tof, and m_veto.

Referenced by clear(), GCOMEventAtom(), and operator=().

void GCOMEventAtom::modcom ( const int &  modcom)
inline

Set mini telescope.

Parameters
[in]modcomMini telescope.

Sets the mini telescope of the event.

Definition at line 487 of file GCOMEventAtom.hpp.

References m_modcom, and modcom().

Referenced by GCOMDri::compute_dre(), and GCOMSelection::use_event().

const int & GCOMEventAtom::modcom ( void  ) const
inline

Return mini telescope.

Returns
Mini telescope.

Returns the mini telescope of the event.

Definition at line 502 of file GCOMEventAtom.hpp.

References m_modcom.

Referenced by modcom().

GCOMEventAtom & GCOMEventAtom::operator= ( const GCOMEventAtom atom)

Assignment operator.

Parameters
[in]atomCOMPTEL event atom.
Returns
COMPTEL event atom.

Definition at line 108 of file GCOMEventAtom.cpp.

References copy_members(), free_members(), init_members(), and GEventAtom::operator=().

void GCOMEventAtom::phi ( const float &  phi)
inline

Set scatter azimuth angle.

Parameters
[in]phiScatter azimuth angle (deg).

Sets scatter azimuth angle.

Definition at line 253 of file GCOMEventAtom.hpp.

References m_phi, and phi().

const float & GCOMEventAtom::phi ( void  ) const
inline

Return scatter azimuth angle.

Returns
Scatter azimuth angle (deg).

Returns scatter azimuth angle.

Definition at line 268 of file GCOMEventAtom.hpp.

References m_phi.

Referenced by phi().

void GCOMEventAtom::phibar ( const float &  phibar)
inline

Set Compton scatter angle.

Parameters
[in]phibarCompton scatter angle (deg).

Sets Compton scatter angle.

Definition at line 224 of file GCOMEventAtom.hpp.

References m_phibar, and phibar().

const float & GCOMEventAtom::phibar ( void  ) const
inline

Return Compton scatter angle.

Returns
Compton scatter angle (deg).

Returns Compton scatter angle.

Definition at line 239 of file GCOMEventAtom.hpp.

References m_phibar.

Referenced by phibar().

std::string GCOMEventAtom::print ( const GChatter chatter = NORMAL) const
virtual

Print event information.

Parameters
[in]chatterChattiness.
Returns
String containing event information.

Implements GEventAtom.

Definition at line 196 of file GCOMEventAtom.cpp.

References GCOMInstDir::dir(), m_dir, m_energy, m_time, GCOMInstDir::phibar(), GEnergy::print(), GTime::print(), SILENT, and gammalib::str().

void GCOMEventAtom::psd ( const float &  psd)
inline

Set PSD value.

Parameters
[in]psdPSD value (channel).

Sets PSD value.

Definition at line 406 of file GCOMEventAtom.hpp.

References m_psd, and psd().

Referenced by GCOMSelection::use_event().

const float & GCOMEventAtom::psd ( void  ) const
inline

Return PSD value.

Returns
PSD value (channel).

Returns the Pulse Shape Discriminator (PSD) channel value of the event. The PSD value is used for the distinction between gammas and neutrons.

Definition at line 428 of file GCOMEventAtom.hpp.

References m_psd.

Referenced by psd().

void GCOMEventAtom::reflag ( const int &  reflag)
inline

Set rejection flag.

Parameters
[in]reflagRejection flag.

Sets the rejection flag of the event.

Definition at line 516 of file GCOMEventAtom.hpp.

References m_reflag, and reflag().

Referenced by GCOMSelection::use_event().

const int & GCOMEventAtom::reflag ( void  ) const
inline

Return rejection flag.

Returns
Rejection flag.

Returns the rejection flag of the event.

Definition at line 531 of file GCOMEventAtom.hpp.

References m_reflag.

Referenced by reflag().

void GCOMEventAtom::theta ( const float &  theta)
inline

Set scatter zenith angle.

Parameters
[in]thetaScatter zenith angle (deg).

Sets scatter zenith angle.

Definition at line 282 of file GCOMEventAtom.hpp.

References m_theta, and theta().

Referenced by GCOMSelection::use_event().

const float & GCOMEventAtom::theta ( void  ) const
inline

Return scatter zenith angle.

Returns
Scatter zenith angle (deg).

Returns scatter zenith angle.

Definition at line 297 of file GCOMEventAtom.hpp.

References m_theta.

Referenced by theta().

const GTime & GCOMEventAtom::time ( void  ) const
inlinevirtual

Return event time.

Returns
Event time.

Returns the event triggering time.

Implements GEventAtom.

Definition at line 195 of file GCOMEventAtom.hpp.

References m_time.

Referenced by time().

void GCOMEventAtom::time ( const GTime time)
inline

Set event time.

Parameters
[in]timeEvent time.

Sets the event time.

Definition at line 209 of file GCOMEventAtom.hpp.

References m_time, and time().

void GCOMEventAtom::time ( const int &  tjd,
const int &  tics 
)

Set event time.

Parameters
[in]tjdTruncated Julian Days (days).
[in]ticsCOMPTEL ticks (1/8 ms).

Sets the event time from the native COMPTEL time format.

Definition at line 180 of file GCOMEventAtom.cpp.

References gammalib::com_time(), and m_time.

void GCOMEventAtom::tof ( const float &  tof)
inline

Set TOF value.

Parameters
[in]tofTOF value (channel).

Sets TOF value.

Definition at line 449 of file GCOMEventAtom.hpp.

References m_tof, and tof().

Referenced by GCOMSelection::use_event().

const float & GCOMEventAtom::tof ( void  ) const
inline

Return TOF value.

Returns
TOF value (channel).

Returns the Time Of Flight (TOF) channel value of the event. The TOF value is used for the distinction between forward and backward scattering events.

Definition at line 473 of file GCOMEventAtom.hpp.

References m_tof.

Referenced by tof().

void GCOMEventAtom::veto ( const int &  veto)
inline

Set veto flag.

Parameters
[in]vetoVeto flag.

Sets the veto flag of the event.

Definition at line 545 of file GCOMEventAtom.hpp.

References m_veto, and veto().

Referenced by GCOMSelection::use_event().

const int & GCOMEventAtom::veto ( void  ) const
inline

Return veto flag.

Returns
Veto flag.

Returns the veto flag of the event.

Definition at line 560 of file GCOMEventAtom.hpp.

References m_veto.

Referenced by veto().

Member Data Documentation

GCOMInstDir GCOMEventAtom::m_dir
protected

Event direction.

Definition at line 100 of file GCOMEventAtom.hpp.

Referenced by copy_members(), dir(), init_members(), and print().

float GCOMEventAtom::m_e1
protected

D1 energy deposit (MeV)

Definition at line 103 of file GCOMEventAtom.hpp.

Referenced by copy_members(), e1(), and init_members().

float GCOMEventAtom::m_e2
protected

D2 energy deposit (MeV)

Definition at line 104 of file GCOMEventAtom.hpp.

Referenced by copy_members(), e2(), and init_members().

float GCOMEventAtom::m_eha
protected

Earth horizon angle (deg)

Definition at line 108 of file GCOMEventAtom.hpp.

Referenced by copy_members(), eha(), and init_members().

GEnergy GCOMEventAtom::m_energy
protected

Event energy.

Definition at line 101 of file GCOMEventAtom.hpp.

Referenced by copy_members(), energy(), init_members(), and print().

int GCOMEventAtom::m_modcom
protected

Mini telescope number.

Definition at line 111 of file GCOMEventAtom.hpp.

Referenced by copy_members(), init_members(), and modcom().

float GCOMEventAtom::m_phi
protected

Azimuth angle of scatter direction (deg)

Definition at line 107 of file GCOMEventAtom.hpp.

Referenced by copy_members(), init_members(), and phi().

float GCOMEventAtom::m_phibar
protected

Compton scatter angle (deg)

Definition at line 105 of file GCOMEventAtom.hpp.

Referenced by copy_members(), init_members(), and phibar().

float GCOMEventAtom::m_psd
protected

PSD value (channel)

Definition at line 109 of file GCOMEventAtom.hpp.

Referenced by copy_members(), init_members(), and psd().

int GCOMEventAtom::m_reflag
protected

Rejection flag.

Definition at line 112 of file GCOMEventAtom.hpp.

Referenced by copy_members(), init_members(), and reflag().

float GCOMEventAtom::m_theta
protected

Zenith angle of scatter direction (deg)

Definition at line 106 of file GCOMEventAtom.hpp.

Referenced by copy_members(), init_members(), and theta().

GTime GCOMEventAtom::m_time
protected

Event time.

Definition at line 102 of file GCOMEventAtom.hpp.

Referenced by copy_members(), init_members(), print(), and time().

float GCOMEventAtom::m_tof
protected

Time of flight value (channel)

Definition at line 110 of file GCOMEventAtom.hpp.

Referenced by copy_members(), init_members(), and tof().

int GCOMEventAtom::m_veto
protected

Veto flag.

Definition at line 113 of file GCOMEventAtom.hpp.

Referenced by copy_members(), init_members(), and veto().


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