COMPTEL Orbit Aspect Data class. More...

#include <GCOMOad.hpp>

Inheritance diagram for GCOMOad:

Public Member Functions
	GCOMOad (void)
	Void constructor. More...

	GCOMOad (const GCOMOad &oad)
	Copy constructor. More...

virtual	~GCOMOad (void)
	Destructor. More...

GCOMOad &	operator= (const GCOMOad &oad)
	Assignment operator. More...

virtual void	clear (void)
	Clear COMPTEL Orbit Aspect Data. More...

virtual GCOMOad *	clone (void) const
	Clone COMPTEL Orbit Aspect Data. More...

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

virtual std::string	print (const GChatter &chatter=NORMAL) const
	Print COMPTEL Orbit Aspect Data. More...

const GTime &	tstart (void) const
	Return start time of superpacket. More...

void	tstart (const GTime &tstart)
	Set start time of superpacket. More...

const GTime &	tstop (void) const
	Return stop time of superpacket. More...

void	tstop (const GTime &tstop)
	Set stop time of superpacket. More...

const int &	tjd (void) const
	Return Truncated Julian Days of Orbit Aspect Record. More...

void	tjd (const int &tjd)
	Set Truncated Julian Days of Orbit Aspect Record. More...

const int &	tics (void) const
	Return tics of Orbit Aspect Record. More...

void	tics (const int &tics)
	Set tics of Orbit Aspect Record. More...

const float &	gcaz (void) const
	Return Geocentre azimuth angle. More...

void	gcaz (const float &gcaz)
	Set Geocentre azimuth angle. More...

const float &	gcel (void) const
	Return Geocentre zenith angle. More...

void	gcel (const float &gcel)
	Set Geocentre zenith angle. More...

const float &	georad (void) const
	Return apparent radius of Earth. More...

void	georad (const float &georad)
	Set apparent radius of Earth. More...

const float &	ehora (void) const
	Return Earth Horizon Angle of telescope pointing axis. More...

void	ehora (const float &ehora)
	Set Earth Horizon Angle of telescope pointing axis. More...

const GSkyDir &	zaxis (void) const
	Return telescope Z-axis. More...

void	zaxis (const GSkyDir &zaxis)
	Set telescope Z-axis. More...

const GSkyDir &	xaxis (void) const
	Return telescope X-axis. More...

void	xaxis (const GSkyDir &xaxis)
	Set telescope X-axis. More...

const GVector &	pos (void) const
	Return telescope position vector (km) More...

void	pos (const GVector &pos)
	Set telescope position vector (km) More...

double	theta (const GSkyDir &sky) const
	Return zenith angle of sky direction in COMPTEL coordinates. More...

double	phi (const GSkyDir &sky) const
	Return azimuth angle of sky direction in COMPTEL coordinates. 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 GCOMOad &oad)
	Copy class members. More...

void	free_members (void)
	Delete class members. More...

Protected Attributes
GTime	m_tstart
	Start time of superpacket. More...

GTime	m_tstop
	Stop time of superpacket. More...

GSkyDir	m_zaxis
	Telescope z-axis. More...

GSkyDir	m_xaxis
	Telescope x-axis. More...

int	m_tjd
	TJD of OAD record. More...

int	m_tics
	Tics of OAD record. More...

float	m_gcaz
	Geocentre azimuth angle (deg) More...

float	m_gcel
	Geocentre zenith angle (deg) More...

float	m_georad
	Apparent radius of Earth (deg) More...

float	m_ehora
	Earth Horizon Angle of telescope pointing (deg) More...

GVector	m_pos
	Position vector (km) More...

double	m_posang
	X-axis position angle in COMPTEL system. More...

Detailed Description

COMPTEL Orbit Aspect Data class.

The class holds one record of a COMPTEL Orbit Aspect Data file.

Definition at line 49 of file GCOMOad.hpp.

Constructor & Destructor Documentation

GCOMOad::GCOMOad ( void )

Void constructor.

Definition at line 53 of file GCOMOad.cpp.

References init_members().

Referenced by clone().

GCOMOad::GCOMOad ( const GCOMOad & oad )

Copy constructor.

Parameters

[in] oad COMPTEL Orbit Aspect Data.

Definition at line 68 of file GCOMOad.cpp.

References copy_members(), and init_members().

GCOMOad::~GCOMOad ( void )

virtual

Destructor.

Definition at line 84 of file GCOMOad.cpp.

References free_members().

Member Function Documentation

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

inlinevirtual

Return class name.

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

Implements GBase.

Definition at line 122 of file GCOMOad.hpp.

void GCOMOad::clear ( void )

virtual

Clear COMPTEL Orbit Aspect Data.

Implements GBase.

Definition at line 136 of file GCOMOad.cpp.

References free_members(), and init_members().

GCOMOad * GCOMOad::clone ( void ) const

virtual

Clone COMPTEL Orbit Aspect Data.

Returns: Pointer to deep copy of COMPTEL Orbit Aspect Data.

Implements GBase.

Definition at line 154 of file GCOMOad.cpp.

References GCOMOad().

void GCOMOad::copy_members ( const GCOMOad & oad )

protected

Copy class members.

Parameters

[in] oad COMPTEL Orbit Aspect Data.

Definition at line 234 of file GCOMOad.cpp.

References m_ehora, m_gcaz, m_gcel, m_georad, m_pos, m_posang, m_tics, m_tjd, m_tstart, m_tstop, m_xaxis, and m_zaxis.

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

const float & GCOMOad::ehora ( void ) const

inline

Return Earth Horizon Angle of telescope pointing axis.

Returns: Earth Horizon Angle of telescope pointing axis (deg).

Returns the Earth Horizon Angle of telescope pointing axis in degrees.

Definition at line 341 of file GCOMOad.hpp.

References m_ehora.

Referenced by ehora(), and GCOMOads::read().

void GCOMOad::ehora ( const float & ehora )

inline

Set Earth Horizon Angle of telescope pointing axis.

Parameters

[in] ehora Earth Horizon Angle of telescope pointing axis (deg).

Set the Earth Horizon Angle of telescope pointing axis.

Definition at line 355 of file GCOMOad.hpp.

References ehora(), and m_ehora.

void GCOMOad::free_members ( void )

protected

Delete class members.

Definition at line 258 of file GCOMOad.cpp.

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

const float & GCOMOad::gcaz ( void ) const

inline

Return Geocentre azimuth angle.

Returns: Geocentre azimuth angle (deg).

Returns the Geocentre azimuth angle in degrees.

Definition at line 254 of file GCOMOad.hpp.

References m_gcaz.

Referenced by GCOMDri::compute_dre(), GCOMDri::compute_drg(), GCOMDris::compute_drws_energy(), GCOMDris::compute_drws_phibar(), gcaz(), GCOMOads::read(), GCOMDris::vetorate_generate(), and GCOMDris::vetorate_setup().

void GCOMOad::gcaz ( const float & gcaz )

inline

Set Geocentre azimuth angle.

Parameters

[in] gcaz Geocentre azimuth angle (deg).

Set the Geocentre azimuth angle.

Definition at line 268 of file GCOMOad.hpp.

References gcaz(), and m_gcaz.

const float & GCOMOad::gcel ( void ) const

inline

Return Geocentre zenith angle.

Returns: Geocentre zenith angle (deg).

Returns the Geocentre zenith angle in degrees.

Definition at line 283 of file GCOMOad.hpp.

References m_gcel.

Referenced by GCOMDri::compute_dre(), GCOMDri::compute_drg(), GCOMDris::compute_drws_energy(), GCOMDris::compute_drws_phibar(), gcel(), GCOMOads::read(), GCOMDris::vetorate_generate(), and GCOMDris::vetorate_setup().

void GCOMOad::gcel ( const float & gcel )

inline

Set Geocentre zenith angle.

Parameters

[in] gcel Geocentre zenith angle (deg).

Set the Geocentre zenith angle.

Definition at line 297 of file GCOMOad.hpp.

References gcel(), and m_gcel.

const float & GCOMOad::georad ( void ) const

inline

Return apparent radius of Earth.

Returns: Apparent radius of Earth (deg).

Returns the apparent radius of Earth in degrees.

Definition at line 312 of file GCOMOad.hpp.

References m_georad.

Referenced by GCOMDri::compute_dre(), GCOMDri::compute_drg(), GCOMDris::compute_drws_energy(), GCOMDris::compute_drws_phibar(), georad(), GCOMOads::read(), GCOMDris::vetorate_generate(), and GCOMDris::vetorate_setup().

void GCOMOad::georad ( const float & georad )

inline

Set apparent radius of Earth.

Parameters

[in] georad Apparent radius of Earth (deg).

Set the apparent radius of Earth.

Definition at line 326 of file GCOMOad.hpp.

References georad(), and m_georad.

void GCOMOad::init_members ( void )

protected

Initialise class members.

Definition at line 208 of file GCOMOad.cpp.

References GSkyDir::clear(), GTime::clear(), m_ehora, m_gcaz, m_gcel, m_georad, m_pos, m_posang, m_tics, m_tjd, m_tstart, m_tstop, m_xaxis, and m_zaxis.

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

GCOMOad & GCOMOad::operator= ( const GCOMOad & oad )

Assignment operator.

Parameters

[in] oad COMPTEL Orbit Aspect Data.

Returns: COMPTEL Orbit Aspect Data.

Definition at line 106 of file GCOMOad.cpp.

References copy_members(), free_members(), and init_members().

double GCOMOad::phi ( const GSkyDir & sky ) const

inline

Return azimuth angle of sky direction in COMPTEL coordinates.

Parameters

[in] sky Sky direction.

Returns: Azimuth angle of sky direction in COMPTEL coordinates (deg).

Returns the azimuth angle of a sky direction in COMPTEL coordinates.

Definition at line 475 of file GCOMOad.hpp.

References m_posang, m_xaxis, m_zaxis, and GSkyDir::posang_deg().

Referenced by GCOMDri::compute_drg(), GCOMDris::compute_drws_energy(), GCOMDris::compute_drws_phibar(), GCOMDris::vetorate_generate(), and GCOMDris::vetorate_setup().

const GVector & GCOMOad::pos ( void ) const

inline

Return telescope position vector (km)

Returns: Telescope position vector (km).

Returns the telescope position vector (km).

Definition at line 430 of file GCOMOad.hpp.

References m_pos.

Referenced by GCOMDri::compute_dre(), pos(), and GCOMOads::read().

void GCOMOad::pos ( const GVector & pos )

inline

Set telescope position vector (km)

Parameters

[in] pos Telescope position vector (km).

Set the telescope position vector (km).

Definition at line 444 of file GCOMOad.hpp.

References m_pos, and pos().

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

virtual

Print COMPTEL Orbit Aspect Data.

Parameters

[in] chatter Chattiness.

Returns: String containing COMPTEL Orbit Aspect Data information.

Implements GBase.

Definition at line 166 of file GCOMOad.cpp.

References m_tics, m_tjd, m_tstart, m_tstop, GTime::mjd(), gammalib::parformat(), SILENT, gammalib::str(), and GTime::utc().

double GCOMOad::theta ( const GSkyDir & sky ) const

inline

Return zenith angle of sky direction in COMPTEL coordinates.

Parameters

[in] sky Sky direction.

Returns: Zenith angle of sky direction in COMPTEL coordinates (deg).

Returns the zenith angle of a sky direction in COMPTEL coordinates.

Definition at line 460 of file GCOMOad.hpp.

References GSkyDir::dist_deg(), and m_zaxis.

Referenced by GCOMDri::compute_drg(), GCOMDris::compute_drws_energy(), GCOMDris::compute_drws_phibar(), GCOMDri::compute_drx(), GCOMDris::vetorate_generate(), and GCOMDris::vetorate_setup().

const int & GCOMOad::tics ( void ) const

inline

Return tics of Orbit Aspect Record.

Returns: Tics of Orbit Aspect Record.

Returns the tics of the Orbit Aspect Record.

Definition at line 225 of file GCOMOad.hpp.

References m_tics.

Referenced by GCOMBvcs::find(), GCOMOads::read(), tics(), and GCOMDris::vetorate_finish().

void GCOMOad::tics ( const int & tics )

inline

Set tics of Orbit Aspect Record.

Parameters

[in] tics Tics of Orbit Aspect Record.

Set the tics of the Orbit Aspect Record.

Definition at line 239 of file GCOMOad.hpp.

References m_tics, and tics().

const int & GCOMOad::tjd ( void ) const

inline

Return Truncated Julian Days of Orbit Aspect Record.

Returns: Truncated Julian Days of Orbit Aspect Record.

Returns the Truncated Julian Days of the Orbit Aspect Record.

Definition at line 196 of file GCOMOad.hpp.

References m_tjd.

Referenced by GCOMDri::compute_drg(), GCOMDris::compute_drws_energy(), GCOMDris::compute_drws_phibar(), GCOMBvcs::find(), GCOMOads::read(), tjd(), GCOMDris::vetorate_finish(), GCOMDris::vetorate_generate(), and GCOMDris::vetorate_setup().

void GCOMOad::tjd ( const int & tjd )

inline

Set Truncated Julian Days of Orbit Aspect Record.

Parameters

[in] tjd Truncated Julian Days of Orbit Aspect Record.

Set the Truncated Julian Days of the Orbit Aspect Record.

Definition at line 210 of file GCOMOad.hpp.

References m_tjd, and tjd().

const GTime & GCOMOad::tstart ( void ) const

inline

Return start time of superpacket.

Returns: Start time of superpacket.

Returns the start time of the superpacket.

Definition at line 136 of file GCOMOad.hpp.

References m_tstart.

Referenced by GCOMDri::compute_dre(), GCOMDris::compute_drws_energy(), GCOMDris::compute_drws_phibar(), GCOMOads::read(), tstart(), GCOMDri::use_superpacket(), and GCOMDris::vetorate_setup().

void GCOMOad::tstart ( const GTime & tstart )

inline

Set start time of superpacket.

Parameters

[in] tstart Start time of superpacket.

Set the start time of the superpacket.

Definition at line 150 of file GCOMOad.hpp.

References m_tstart, and tstart().

const GTime & GCOMOad::tstop ( void ) const

inline

Return stop time of superpacket.

Returns: Stop time of superpacket.

Returns the stop time of the superpacket. The stop time is defined as the start time plus 131071 tics, since the length of one superpacket is 16.384 secs, i.e. 16.384 * 8000 = 131072 ticks.

Definition at line 167 of file GCOMOad.hpp.

References m_tstop.

Referenced by GCOMDri::compute_dre(), GCOMDris::compute_drws_energy(), GCOMDris::compute_drws_phibar(), GCOMOads::read(), tstop(), GCOMDri::use_superpacket(), and GCOMDris::vetorate_setup().