Fermi/LAT event atom class. More...

#include <GLATEventAtom.hpp>

Inheritance diagram for GLATEventAtom:

Public Member Functions
	GLATEventAtom (void)
	Void constructor.

	GLATEventAtom (const GLATEventAtom &atom)
	Copy constructor.

virtual	~GLATEventAtom (void)
	Destructor.

GLATEventAtom &	operator= (const GLATEventAtom &atom)
	Assignment operator.

void	clear (void)
	Clear event atom.

GLATEventAtom *	clone (void) const
	Clone event atom.

std::string	classname (void) const
	Return class name.

const GLATInstDir &	dir (void) const
	Return event instrument direction.

const GEnergy &	energy (void) const
	Return event energy.

const GTime &	time (void) const
	Return event time.

std::string	print (const GChatter &chatter=NORMAL) const
	Print event information.

Public Member Functions inherited from GEventAtom
	GEventAtom (void)
	Void constructor.

	GEventAtom (const GEventAtom &atom)
	Copy constructor.

virtual	~GEventAtom (void)
	Destructor.

virtual GEventAtom &	operator= (const GEventAtom &atom)
	Assignment operator.

virtual double	size (void) const
	Return size of an event atom.

virtual double	counts (void) const
	Return number of counts in event atom.

virtual double	error (void) const
	Return error in number of counts in event atom.

bool	is_atom (void) const
	Signal if event is an atom.

bool	is_bin (void) const
	Signal if event is a bin.

Public Member Functions inherited from GEvent
	GEvent (void)
	Void constructor.

	GEvent (const GEvent &event)
	Copy constructor.

virtual	~GEvent (void)
	Destructor.

virtual GEvent &	operator= (const GEvent &event)
	Assignment operator.

Public Member Functions inherited from GBase
virtual	~GBase (void)
	Destructor.

Protected Member Functions
void	init_members (void)
	Initialise class members.

void	copy_members (const GLATEventAtom &atom)
	Copy class members.

void	free_members (void)
	Delete class members.

Protected Member Functions inherited from GEventAtom
void	init_members (void)
	Initialise class members.

void	copy_members (const GEventAtom &atom)
	Copy class members.

void	free_members (void)
	Delete class members.

Protected Member Functions inherited from GEvent
void	init_members (void)
	Initialise class members.

void	copy_members (const GEvent &event)
	Copy class members.

void	free_members (void)
	Delete class members.

Protected Attributes
GLATInstDir	m_dir
	Event direction.

GEnergy	m_energy
	Event energy.

GTime	m_time
	Event time.

float	m_theta
	Zenith angle in instrument system.

float	m_phi
	Azimuth angle in instrument system.

float	m_zenith_angle
	Zenith angle in Earth system.

float	m_earth_azimuth_angle
	Azimuth angle in Earth system.

long	m_event_id
	ID number of original event.

long	m_run_id
	Run number of original event.

short	m_recon_version
	Version of event reconstruction software.

short	m_calib_version [3]
	Version of calibration tables for ACD, CAL.

short	m_event_class
	Event class: 0, 1, 2, ...

short	m_conversion_type
	Type of conversion: 0=Front, 1=Back.

double	m_livetime
	Accumulated livetime since mission start.

double *	m_difrsp
	Diffuse response components.

int	m_num_difrsp
	Number of diffuse model components.

Friends
class	GLATEventList

Detailed Description

Fermi/LAT event atom class.

Definition at line 43 of file GLATEventAtom.hpp.

Constructor & Destructor Documentation

◆ GLATEventAtom() [1/2]

GLATEventAtom::GLATEventAtom ( void )

Void constructor.

Definition at line 53 of file GLATEventAtom.cpp.

References init_members().

Referenced by clone().

◆ GLATEventAtom() [2/2]

GLATEventAtom::GLATEventAtom ( const GLATEventAtom & atom )

Copy constructor.

Parameters

[in] atom Event atom.

Definition at line 68 of file GLATEventAtom.cpp.

References copy_members(), and init_members().

◆ ~GLATEventAtom()

GLATEventAtom::~GLATEventAtom ( void )

virtual

Destructor.

Definition at line 84 of file GLATEventAtom.cpp.

References free_members().

Member Function Documentation

◆ classname()

std::string GLATEventAtom::classname ( void ) const

inlinevirtual

Return class name.

Returns: String containing the class name ("GLATEventAtom").

Implements GEventAtom.

Definition at line 98 of file GLATEventAtom.hpp.

◆ clear()

void GLATEventAtom::clear ( void )

virtual

Clear event atom.

Implements GEventAtom.

Definition at line 139 of file GLATEventAtom.cpp.

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

◆ clone()

GLATEventAtom * GLATEventAtom::clone ( void ) const

virtual

Clone event atom.

Returns: Pointer to deep copy of event atom

Implements GEventAtom.

Definition at line 161 of file GLATEventAtom.cpp.

References GLATEventAtom().

◆ copy_members()

void GLATEventAtom::copy_members ( const GLATEventAtom & atom )

protected

Copy class members.

Parameters

[in] atom Event atom.

Definition at line 234 of file GLATEventAtom.cpp.

References m_calib_version, m_conversion_type, m_difrsp, m_dir, m_earth_azimuth_angle, m_energy, m_event_class, m_event_id, m_livetime, m_num_difrsp, m_phi, m_recon_version, m_run_id, m_theta, m_time, and m_zenith_angle.

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

◆ dir()

const GLATInstDir & GLATEventAtom::dir ( void ) const

inlinevirtual

Return event instrument direction.

Returns: Event instrument direction.

Returns the reconstructed arrival direction of the photon on the sky.

Implements GEventAtom.

Definition at line 112 of file GLATEventAtom.hpp.

References m_dir.

◆ energy()

const GEnergy & GLATEventAtom::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 126 of file GLATEventAtom.hpp.

References m_energy.

◆ free_members()

void GLATEventAtom::free_members ( void )

protected

Delete class members.

Definition at line 278 of file GLATEventAtom.cpp.

References m_difrsp.

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

◆ init_members()

void GLATEventAtom::init_members ( void )

protected

Initialise class members.

Definition at line 202 of file GLATEventAtom.cpp.

References GEnergy::clear(), GLATInstDir::clear(), GTime::clear(), m_calib_version, m_conversion_type, m_difrsp, m_dir, m_earth_azimuth_angle, m_energy, m_event_class, m_event_id, m_livetime, m_num_difrsp, m_phi, m_recon_version, m_run_id, m_theta, m_time, and m_zenith_angle.

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

◆ operator=()

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

Assignment operator.

Parameters

[in] atom Event atom.

Returns: Event atom.

Definition at line 106 of file GLATEventAtom.cpp.

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

◆ print()

std::string GLATEventAtom::print ( const GChatter & chatter = NORMAL ) const

virtual

Print event information.

Parameters

[in] chatter Chattiness (defaults to NORMAL).

Returns: String containing event information.

Implements GEventAtom.

Definition at line 173 of file GLATEventAtom.cpp.

References m_dir, m_energy, m_time, GEnergy::print(), GLATInstDir::print(), GTime::print(), and SILENT.

◆ time()

const GTime & GLATEventAtom::time ( void ) const

inlinevirtual

Return event time.

Returns: Event time.

Returns the event triggering time.

Implements GEventAtom.

Definition at line 140 of file GLATEventAtom.hpp.

References m_time.

Friends And Related Symbol Documentation

◆ GLATEventList

friend class GLATEventList

friend

Definition at line 46 of file GLATEventAtom.hpp.

Member Data Documentation

◆ m_calib_version

short GLATEventAtom::m_calib_version[3]

protected

Version of calibration tables for ACD, CAL.

Definition at line 83 of file GLATEventAtom.hpp.

Referenced by copy_members(), and init_members().

◆ m_conversion_type

short GLATEventAtom::m_conversion_type

protected

Type of conversion: 0=Front, 1=Back.

Definition at line 85 of file GLATEventAtom.hpp.

Referenced by copy_members(), and init_members().

◆ m_difrsp

double* GLATEventAtom::m_difrsp

protected

Diffuse response components.

Definition at line 87 of file GLATEventAtom.hpp.

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

◆ m_dir

GLATInstDir GLATEventAtom::m_dir

protected

Event direction.

Definition at line 73 of file GLATEventAtom.hpp.

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

◆ m_earth_azimuth_angle

float GLATEventAtom::m_earth_azimuth_angle

protected

Azimuth angle in Earth system.

Definition at line 79 of file GLATEventAtom.hpp.

Referenced by copy_members(), and init_members().

◆ m_energy

GEnergy GLATEventAtom::m_energy

protected

Event energy.

Definition at line 74 of file GLATEventAtom.hpp.

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

◆ m_event_class

short GLATEventAtom::m_event_class

protected

Event class: 0, 1, 2, ...

Definition at line 84 of file GLATEventAtom.hpp.

Referenced by copy_members(), and init_members().

◆ m_event_id

long GLATEventAtom::m_event_id

protected

ID number of original event.

Definition at line 80 of file GLATEventAtom.hpp.

Referenced by copy_members(), and init_members().

◆ m_livetime

double GLATEventAtom::m_livetime

protected

Accumulated livetime since mission start.

Definition at line 86 of file GLATEventAtom.hpp.

Referenced by copy_members(), and init_members().

◆ m_num_difrsp

int GLATEventAtom::m_num_difrsp

protected

Number of diffuse model components.

Definition at line 88 of file GLATEventAtom.hpp.

Referenced by copy_members(), and init_members().

◆ m_phi

float GLATEventAtom::m_phi

protected

Azimuth angle in instrument system.

Definition at line 77 of file GLATEventAtom.hpp.

Referenced by copy_members(), and init_members().

◆ m_recon_version

short GLATEventAtom::m_recon_version

protected

Version of event reconstruction software.

Definition at line 82 of file GLATEventAtom.hpp.

Referenced by copy_members(), and init_members().

◆ m_run_id

long GLATEventAtom::m_run_id

protected

Run number of original event.

Definition at line 81 of file GLATEventAtom.hpp.

Referenced by copy_members(), and init_members().

◆ m_theta

float GLATEventAtom::m_theta

protected

Zenith angle in instrument system.

Definition at line 76 of file GLATEventAtom.hpp.

Referenced by copy_members(), and init_members().

◆ m_time

GTime GLATEventAtom::m_time

protected

Event time.

Definition at line 75 of file GLATEventAtom.hpp.

Referenced by copy_members(), init_members(), print(), GLATEventList::read_events(), and time().

◆ m_zenith_angle

float GLATEventAtom::m_zenith_angle

protected

Zenith angle in Earth system.

Definition at line 78 of file GLATEventAtom.hpp.

Referenced by copy_members(), and init_members().

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

inst/lat/include/GLATEventAtom.hpp
inst/lat/src/GLATEventAtom.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ GLATEventAtom() [1/2]

◆ GLATEventAtom() [2/2]

◆ ~GLATEventAtom()

Member Function Documentation

◆ classname()

◆ clear()

◆ clone()

◆ copy_members()

◆ dir()

◆ energy()

◆ free_members()

◆ init_members()

◆ operator=()

◆ print()

◆ time()

Friends And Related Symbol Documentation

◆ GLATEventList

Member Data Documentation

◆ m_calib_version

◆ m_conversion_type

◆ m_difrsp

◆ m_dir

◆ m_earth_azimuth_angle

◆ m_energy

◆ m_event_class

◆ m_event_id

◆ m_livetime

◆ m_num_difrsp

◆ m_phi

◆ m_recon_version

◆ m_run_id

◆ m_theta

◆ m_time

◆ m_zenith_angle