GammaLib
2.0.0
|
COMPTEL event atom class. More...
#include <GCOMEventAtom.hpp>
Public Member Functions | |
GCOMEventAtom (void) | |
Void constructor. More... | |
GCOMEventAtom (const GCOMEventAtom &atom) | |
Copy constructor. More... | |
virtual | ~GCOMEventAtom (void) |
Destructor. More... | |
GCOMEventAtom & | operator= (const GCOMEventAtom &atom) |
Assignment operator. More... | |
void | clear (void) |
Clear event atom. More... | |
GCOMEventAtom * | clone (void) const |
Clone event atom. More... | |
std::string | classname (void) const |
Return class name. More... | |
const GCOMInstDir & | dir (void) const |
Return event instrument direction. More... | |
const GEnergy & | energy (void) const |
Return event energy. More... | |
const GTime & | time (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 | x_d2 (const float &x_d2) |
Set D2 module X value. More... | |
const float & | x_d2 (void) const |
Return D2 module X value. More... | |
void | y_d2 (const float &y_d2) |
Set D2 module Y value. More... | |
const float & | y_d2 (void) const |
Return D2 module Y 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 GEventAtom & | operator= (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 GEvent & | operator= (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... | |
float | m_x_d2 |
D2 model X position (mm) More... | |
float | m_y_d2 |
D2 model X position (mm) More... | |
int | m_modcom |
Mini telescope number. More... | |
int | m_reflag |
Rejection flag. More... | |
int | m_veto |
Veto flag. More... | |
COMPTEL event atom class.
Definition at line 45 of file GCOMEventAtom.hpp.
GCOMEventAtom::GCOMEventAtom | ( | void | ) |
Void constructor.
Creates an empty COMPTEL event atom.
Definition at line 57 of file GCOMEventAtom.cpp.
References init_members().
Referenced by clone().
GCOMEventAtom::GCOMEventAtom | ( | const GCOMEventAtom & | atom | ) |
Copy constructor.
[in] | atom | COMPTEL event atom. |
Definition at line 72 of file GCOMEventAtom.cpp.
References copy_members(), and init_members().
|
virtual |
|
inlinevirtual |
Return class name.
Implements GEventAtom.
Definition at line 129 of file GCOMEventAtom.hpp.
|
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 146 of file GCOMEventAtom.cpp.
References GEventAtom::free_members(), GEvent::free_members(), free_members(), GEventAtom::init_members(), GEvent::init_members(), and init_members().
|
virtual |
Clone event atom.
Implements GEventAtom.
Definition at line 168 of file GCOMEventAtom.cpp.
References GCOMEventAtom().
|
protected |
|
inlinevirtual |
Return event instrument direction.
Returns the direction of the event.
Implements GEventAtom.
Definition at line 143 of file GCOMEventAtom.hpp.
References m_dir.
Referenced by dir().
|
inline |
Set event instrument direction.
[in] | dir | Event instrument direction. |
Sets the event instrument direction.
Definition at line 157 of file GCOMEventAtom.hpp.
|
inline |
Set D1 module energy deposit.
[in] | e1 | D1 module energy deposit (MeV). |
Sets D1 module energy deposit.
Definition at line 346 of file GCOMEventAtom.hpp.
Referenced by GCOMSelection::use_event().
|
inline |
Return D1 module energy deposit.
Returns D1 module energy deposit.
Definition at line 361 of file GCOMEventAtom.hpp.
References m_e1.
Referenced by e1().
|
inline |
Set D2 module energy deposit.
[in] | e2 | D2 module energy deposit (MeV). |
Sets D2 module energy deposit.
Definition at line 375 of file GCOMEventAtom.hpp.
Referenced by GCOMSelection::use_event().
|
inline |
Return D2 module energy deposit.
Returns D2 module energy deposit.
Definition at line 390 of file GCOMEventAtom.hpp.
References m_e2.
Referenced by e2().
|
inline |
Set Earth horizon angle.
[in] | eha | Earth horizon angle (deg). |
Sets Earth horizon angle.
Definition at line 317 of file GCOMEventAtom.hpp.
|
inline |
Return Earth horizon angle.
Returns Earth horizon angle.
Definition at line 332 of file GCOMEventAtom.hpp.
References m_eha.
Referenced by eha().
|
inlinevirtual |
Return event energy.
Returns the reconstructed energy of the photon on the sky.
Implements GEventAtom.
Definition at line 172 of file GCOMEventAtom.hpp.
References m_energy.
Referenced by energy().
|
inline |
Set event energy.
[in] | energy | Event energy. |
Sets the event energy.
Definition at line 186 of file GCOMEventAtom.hpp.
|
protected |
Delete class members.
Definition at line 287 of file GCOMEventAtom.cpp.
Referenced by clear(), operator=(), and ~GCOMEventAtom().
|
protected |
Initialise class members.
Definition at line 229 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, m_veto, m_x_d2, and m_y_d2.
Referenced by clear(), GCOMEventAtom(), and operator=().
|
inline |
Set mini telescope.
[in] | modcom | Mini telescope. |
Sets the mini telescope of the event.
Definition at line 521 of file GCOMEventAtom.hpp.
References m_modcom, and modcom().
Referenced by GCOMSelection::use_event().
|
inline |
Return mini telescope.
Returns the mini telescope of the event.
Definition at line 536 of file GCOMEventAtom.hpp.
References m_modcom.
Referenced by modcom().
GCOMEventAtom & GCOMEventAtom::operator= | ( | const GCOMEventAtom & | atom | ) |
Assignment operator.
[in] | atom | COMPTEL event atom. |
Definition at line 110 of file GCOMEventAtom.cpp.
References copy_members(), free_members(), init_members(), and GEventAtom::operator=().
|
inline |
Set scatter azimuth angle.
[in] | phi | Scatter azimuth angle (deg). |
Sets scatter azimuth angle.
Definition at line 259 of file GCOMEventAtom.hpp.
|
inline |
Return scatter azimuth angle.
Returns scatter azimuth angle.
Definition at line 274 of file GCOMEventAtom.hpp.
References m_phi.
Referenced by phi().
|
inline |
Set Compton scatter angle.
[in] | phibar | Compton scatter angle (deg). |
Sets Compton scatter angle.
Definition at line 230 of file GCOMEventAtom.hpp.
|
inline |
Return Compton scatter angle.
Returns Compton scatter angle.
Definition at line 245 of file GCOMEventAtom.hpp.
References m_phibar.
Referenced by phibar().
Print event information.
[in] | chatter | Chattiness. |
Implements GEventAtom.
Definition at line 198 of file GCOMEventAtom.cpp.
References GCOMInstDir::dir(), m_dir, m_energy, m_time, GCOMInstDir::phibar(), GEnergy::print(), GTime::print(), SILENT, and gammalib::str().
|
inline |
Set PSD value.
[in] | psd | PSD value (channel). |
Sets PSD value.
Definition at line 404 of file GCOMEventAtom.hpp.
Referenced by GCOMSelection::use_event().
|
inline |
Return PSD value.
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 419 of file GCOMEventAtom.hpp.
References m_psd.
Referenced by psd().
|
inline |
Set rejection flag.
[in] | reflag | Rejection flag. |
Sets the rejection flag of the event.
Definition at line 550 of file GCOMEventAtom.hpp.
References m_reflag, and reflag().
Referenced by GCOMSelection::use_event().
|
inline |
Return rejection flag.
Returns the rejection flag of the event.
Definition at line 565 of file GCOMEventAtom.hpp.
References m_reflag.
Referenced by reflag().
|
inline |
Set scatter zenith angle.
[in] | theta | Scatter zenith angle (deg). |
Sets scatter zenith angle.
Definition at line 288 of file GCOMEventAtom.hpp.
References m_theta, and theta().
Referenced by GCOMSelection::use_event().
|
inline |
Return scatter zenith angle.
Returns scatter zenith angle.
Definition at line 303 of file GCOMEventAtom.hpp.
References m_theta.
Referenced by theta().
|
inlinevirtual |
Return event time.
Returns the event triggering time.
Implements GEventAtom.
Definition at line 201 of file GCOMEventAtom.hpp.
References m_time.
Referenced by time(), and GCOMSelection::use_event().
|
inline |
Set event time.
[in] | time | Event time. |
Sets the event time.
Definition at line 215 of file GCOMEventAtom.hpp.
void GCOMEventAtom::time | ( | const int & | tjd, |
const int & | tics | ||
) |
Set event time.
[in] | tjd | Truncated Julian Days (days). |
[in] | tics | COMPTEL ticks (1/8 ms). |
Sets the event time from the native COMPTEL time format.
Definition at line 182 of file GCOMEventAtom.cpp.
References gammalib::com_time(), and m_time.
|
inline |
Set TOF value.
[in] | tof | TOF value (channel). |
Sets TOF value.
Definition at line 432 of file GCOMEventAtom.hpp.
Referenced by GCOMSelection::use_event().
|
inline |
Return TOF value.
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 449 of file GCOMEventAtom.hpp.
References m_tof.
Referenced by tof().
|
inline |
Set veto flag.
[in] | veto | Veto flag. |
Sets the veto flag of the event.
Definition at line 579 of file GCOMEventAtom.hpp.
References m_veto, and veto().
Referenced by GCOMSelection::use_event().
|
inline |
Return veto flag.
Returns the veto flag of the event.
Definition at line 594 of file GCOMEventAtom.hpp.
References m_veto.
Referenced by veto().
|
inline |
Set D2 module X value.
[in] | x_d2 | D2 module X value (mm). |
Sets D2 module X value.
Definition at line 463 of file GCOMEventAtom.hpp.
|
inline |
Return D2 module X value.
Returns the D2 module X value of the event.
Definition at line 478 of file GCOMEventAtom.hpp.
References m_x_d2.
Referenced by x_d2().
|
inline |
Set D2 module Y value.
[in] | y_d2 | D2 module Y value (mm). |
Sets D2 module Y value.
Definition at line 492 of file GCOMEventAtom.hpp.
|
inline |
Return D2 module Y value.
Returns the D2 module Y value of the event.
Definition at line 507 of file GCOMEventAtom.hpp.
References m_y_d2.
Referenced by y_d2().
|
protected |
Event direction.
Definition at line 104 of file GCOMEventAtom.hpp.
Referenced by copy_members(), dir(), init_members(), and print().
|
protected |
D1 energy deposit (MeV)
Definition at line 107 of file GCOMEventAtom.hpp.
Referenced by copy_members(), e1(), and init_members().
|
protected |
D2 energy deposit (MeV)
Definition at line 108 of file GCOMEventAtom.hpp.
Referenced by copy_members(), e2(), and init_members().
|
protected |
Earth horizon angle (deg)
Definition at line 112 of file GCOMEventAtom.hpp.
Referenced by copy_members(), eha(), and init_members().
|
protected |
Event energy.
Definition at line 105 of file GCOMEventAtom.hpp.
Referenced by copy_members(), energy(), init_members(), and print().
|
protected |
Mini telescope number.
Definition at line 117 of file GCOMEventAtom.hpp.
Referenced by copy_members(), init_members(), and modcom().
|
protected |
Azimuth angle of scatter direction (deg)
Definition at line 111 of file GCOMEventAtom.hpp.
Referenced by copy_members(), init_members(), and phi().
|
protected |
Compton scatter angle (deg)
Definition at line 109 of file GCOMEventAtom.hpp.
Referenced by copy_members(), init_members(), and phibar().
|
protected |
PSD value (channel)
Definition at line 113 of file GCOMEventAtom.hpp.
Referenced by copy_members(), init_members(), and psd().
|
protected |
Rejection flag.
Definition at line 118 of file GCOMEventAtom.hpp.
Referenced by copy_members(), init_members(), and reflag().
|
protected |
Zenith angle of scatter direction (deg)
Definition at line 110 of file GCOMEventAtom.hpp.
Referenced by copy_members(), init_members(), and theta().
|
protected |
Event time.
Definition at line 106 of file GCOMEventAtom.hpp.
Referenced by copy_members(), init_members(), print(), and time().
|
protected |
Time of flight value (channel)
Definition at line 114 of file GCOMEventAtom.hpp.
Referenced by copy_members(), init_members(), and tof().
|
protected |
Veto flag.
Definition at line 119 of file GCOMEventAtom.hpp.
Referenced by copy_members(), init_members(), and veto().
|
protected |
D2 model X position (mm)
Definition at line 115 of file GCOMEventAtom.hpp.
Referenced by copy_members(), init_members(), and x_d2().
|
protected |
D2 model X position (mm)
Definition at line 116 of file GCOMEventAtom.hpp.
Referenced by copy_members(), init_members(), and y_d2().