Interface class for COMPTEL observations. More...

#include <GCOMObservation.hpp>

Inheritance diagram for GCOMObservation:

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

	GCOMObservation (const GXmlElement &xml)
	XML constructor. More...

	GCOMObservation (const GCOMDri &dre, const GCOMDri &drb, const GCOMDri &drg, const GCOMDri &drx)
	Binned observation DRI constructor. More...

	GCOMObservation (const GFilename &drename, const GFilename &drbname, const GFilename &drgname, const GFilename &drxname)
	Binned observation filename constructor. More...

	GCOMObservation (const GFilename &evpname, const GFilename &timname, const std::vector< GFilename > &oadnames, const GFilename &bvcname="")
	Unbinned observation constructor. More...

	GCOMObservation (const GCOMObservation &obs)
	Copy constructor. More...

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

virtual GCOMObservation &	operator= (const GCOMObservation &obs)
	Assignment operator. More...

virtual void	clear (void)
	Clear COMPTEL observation. More...

virtual GCOMObservation *	clone (void) const
	Clone COMPTEL observation. More...

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

virtual void	response (const GResponse &rsp)
	Set response function. More...

virtual const GCOMResponse *	response (void) const
	Return response function. More...

virtual std::string	instrument (void) const
	Return instrument. More...

virtual double	ontime (void) const
	Return ontime. More...

virtual double	livetime (void) const
	Return livetime. More...

virtual double	deadc (const GTime &time=GTime()) const
	Return deadtime correction factor. More...

virtual void	read (const GXmlElement &xml)
	Read observation from XML element. More...

virtual void	write (GXmlElement &xml) const
	Write observation into XML element. More...

virtual std::string	print (const GChatter &chatter=NORMAL) const
	Print observation information. More...

bool	is_unbinned (void) const
	Check whether observation is unbinned. More...

bool	is_binned (void) const
	Check whether observation is binned. More...

void	load (const GFilename &drename, const GFilename &drbname, const GFilename &drgname, const GFilename &drxname)
	Load data for a binned observation. More...

void	load (const GFilename &evpname, const GFilename &timname, const std::vector< GFilename > &oadnames, const GFilename &bvcname="")
	Load data for an unbinned observation. More...

void	response (const GCaldb &caldb, const std::string &rspname)
	Set response function. More...

void	response (const GCOMResponse &response)
	Set response function. More...

void	obs_id (const double &id)
	Set observation ID. More...

void	ontime (const double &ontime)
	Set ontime. More...

void	livetime (const double &livetime)
	Set livetime. More...

void	deadc (const double &deadc)
	Set deadtime correction factor. More...

void	ewidth (const double &ewidth)
	Set energy width. More...

const double &	obs_id (void) const
	Return observation ID. More...

const double &	ewidth (void) const
	Return energy width. More...

const GCOMDri &	drb (void) const
	Return background model. More...

const GCOMDri &	drg (void) const
	Return geometry factors. More...

const GCOMDri &	drx (void) const
	Return exposure. More...

GCOMDri	drm (const GModels &models) const
	Compute DRM cube. More...

const GCOMTim &	tim (void) const
	Return COMPTEL Good Time Intervals. More...

void	tim (const GCOMTim &tim)
	Set COMPTEL Good Time Intervals. More...

const GCOMOads &	oads (void) const
	Return Orbit Aspect Data. More...

void	oads (const GCOMOads &oads)
	Set Orbit Aspect Data. More...

const GCOMBvcs &	bvcs (void) const
	Return Solar System Barycentre Data. More...

void	bvcs (const GCOMBvcs &bvcs)
	Set Solar System Barycentre Data. More...

const GFilename &	drename (void) const
	Return DRE filename. More...

const GFilename &	drbname (void) const
	Return DRB filename. More...

const GFilename &	drgname (void) const
	Return DRG filename. More...

const GFilename &	drxname (void) const
	Return DRX filename. More...

const int &	phi_first (void) const
	Return index of first Phibar layer to be used for likelihood fitting. More...

const int &	phi_last (void) const
	Return index of last Phibar layer to be used for likelihood fitting. More...

void	drename (const GFilename &drename)
	Set DRE filename. More...

void	drbname (const GFilename &drbname)
	Set DRB filename. More...

void	drgname (const GFilename &drgname)
	Set DRG filename. More...

void	drxname (const GFilename &drxname)
	Set DRX filename. More...

void	phi_first (const int &phi_first)
	Set index of first Phibar layer to be used for likelihood fitting. More...

void	phi_last (const int &phi_last)
	Set index of last Phibar layer to be used for likelihood fitting. More...

void	compute_drb (const std::string &method, const GCOMDri &drm, const int &nrunav=3, const int &navgr=3, const int &nincl=13, const int &nexcl=0)
	Compute DRB cube. More...

Public Member Functions inherited from GObservation
	GObservation (void)
	Void constructor. More...

	GObservation (const GObservation &obs)
	Copy constructor. More...

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

virtual GObservation &	operator= (const GObservation &obs)
	Assignment operator. More...

virtual GEvents *	events (void)
	Return events. More...

virtual const GEvents *	events (void) const
	Return events (const version) More...

virtual void	events (const GEvents &events)
	Set event container. More...

virtual double	likelihood (const GModels &models, GVector gradients, GMatrixSparse curvature, double *npred) const
	Compute likelihood function. More...

virtual double	model (const GModels &models, const GEvent &event, GVector *gradients=NULL) const
	Return model value and (optionally) gradients. More...

virtual GVector	model (const GModels &models, GMatrixSparse *gradients=NULL) const
	Return vector of model values and (optionally) gradients. More...

virtual int	nobserved (void) const
	Return total number of observed events. More...

virtual double	npred (const GModels &models, GVector *gradients=NULL) const
	Return total number (and optionally gradients) of predicted counts for all models. More...

virtual double	npred (const GModel &model) const
	Return total number of predicted counts for one model. More...

virtual double	model_grad (const GModel &model, const GModelPar &par, const GEvent &event) const
	Returns parameter gradient of model for a given event. More...

virtual GVector	model_grad (const GModel &model, const GModelPar &par) const
	Returns parameter gradients of model for all events. More...

virtual double	npred_grad (const GModel &model, const GModelPar &par) const
	Returns parameter gradient of Npred. More...

virtual void	remove_response_cache (const std::string &name)
	Response cache removal hook. More...

virtual const double &	grad_step_size (void) const
	Return gradient step size. More...

bool	has_events (void) const
	Signal if observation has events. More...

bool	has_gradient (const GModel &model, const GModelPar &par) const
	Check whether a model parameter has an analytical gradient. More...

void	name (const std::string &name)
	Set observation name. More...

void	id (const std::string &id)
	Set observation identifier. More...

void	statistic (const std::string &statistic)
	Set optimizer statistic. More...

const std::string &	name (void) const
	Return observation name. More...

const std::string &	id (void) const
	Return observation identifier. More...

const std::string &	statistic (void) const
	Return optimizer statistic. More...

void	computed_gradient (const GModel &model, const GModelPar &par) const
	Signals that an analytical gradient was computed for a model parameter. 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 GCOMObservation &obs)
	Copy class members. More...

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

void	load_dre (const GFilename &drename)
	Load event cube data from DRE file. More...

void	load_drb (const GFilename &drbname)
	Load background model from DRB file. More...

void	load_drg (const GFilename &drgname)
	Load geometry factors from DRG file. More...

void	load_drx (const GFilename &drxname)
	Load exposure from DRX file. More...

bool	check_dri (const GCOMDri &map) const
	Check if DRI is compatible with event cube. More...

void	read_attributes (const GFitsHDU *hdu)
	Read observation attributes. More...

void	write_attributes (GFitsHDU *hdu) const
	Write observation attributes. More...

void	compute_drb_phinor (const GCOMDri &drm)
	Compute DRB cube using PHINOR method. More...

void	compute_drb_bgdlixa (const GCOMDri &drm, const int &nrunav=3, const int &navgr=3, const int &nincl=13, const int &nexcl=0)
	Compute DRB cube using BGDLIXA method. More...

void	compute_drb_bgdlixe (const GCOMDri &drm, const int &nrunav=3, const int &navgr=3, const int &nincl=13, const int &nexcl=0)
	Compute DRB cube using BGDLIXE method. More...

GSkyMap	get_weighted_drg_map (void) const
	Return weighted DRG map. More...

void	get_bgdlixa_phibar_indices (const int &iphibar, const int &nincl, const int &nexcl, int isel1, int iex1, int iex2, int isel2) const
	Compute Phibar index range for BGDLIXA background method. More...

virtual bool	use_event_for_likelihood (const int &index) const
	Check whether bin should be used for likelihood analysis. More...

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

void	copy_members (const GObservation &obs)
	Copy class members. More...

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

virtual double	likelihood_poisson_unbinned (const GModels &models, GVector gradients, GMatrixSparse curvature, double *npred) const
	Evaluate log-likelihood function for Poisson statistic and unbinned analysis (version with working arrays) More...

virtual double	likelihood_poisson_binned (const GModels &models, GVector gradients, GMatrixSparse curvature, double *npred) const
	Evaluate log-likelihood function for Poisson statistic and binned analysis (version with working arrays) More...

virtual double	likelihood_gaussian_binned (const GModels &models, GVector gradients, GMatrixSparse curvature, double *npred) const
	Evaluate log-likelihood function for Gaussian statistic and binned analysis (version with working arrays) More...

virtual double	npred_spec (const GModel &model, const GTime &obsTime) const
	Integrates spatially integrated Npred kernel spectrally. More...

Protected Attributes
std::string	m_instrument
	Instrument name. More...

GCOMResponse	m_response
	Response functions. More...

double	m_obs_id
	Observation ID. More...

double	m_ontime
	Ontime (sec) More...

double	m_livetime
	Livetime (sec) More...

double	m_deadc
	Deadtime correction. More...

GFilename	m_drename
	DRE filename. More...

GFilename	m_drbname
	DRB filename. More...

GFilename	m_drgname
	DRG filename. More...

GFilename	m_drxname
	DRX filename. More...

GCOMDri	m_drb
	Background model. More...

GCOMDri	m_drg
	Geometry factors. More...

GCOMDri	m_drx
	Exposure map. More...

double	m_ewidth
	Energy width (MeV) More...

int	m_phi_first
	First Phibar layer to use for likelihood. More...

int	m_phi_last
	Last Phibar layer to use for likelihood. More...

GFilename	m_evpname
	EVP filename. More...

GFilename	m_timname
	TIM filename. More...

std::vector< GFilename >	m_oadnames
	OAD filenames. More...

GFilename	m_bvcname
	BVC filename. More...

GCOMTim	m_tim
	COMPTEL Good Time Intervals. More...

GCOMOads	m_oads
	Orbit Aspect Data. More...

GCOMBvcs	m_bvcs
	Solar System Barycentre Data. More...

Protected Attributes inherited from GObservation
std::string	m_name
	Observation name. More...

std::string	m_id
	Observation identifier. More...

std::string	m_statistic
	Optimizer statistic. More...

GEvents *	m_events
	Pointer to event container. More...

double	m_grad_step_size
	Gradient step size. More...

std::vector< std::string >	m_pars_with_gradients

Detailed Description

Interface class for COMPTEL observations.

This class implements a COMPTEL observation. Each COMPTEL observation is defined for a given energy range, and is composed of a DRE, DRB, DRG and DRX file. The DRE file contains the event data, the DRB file contains a background model, the DRG file contains geometry factors, and the DRX file contains the exposure.

Definition at line 65 of file GCOMObservation.hpp.

Constructor & Destructor Documentation

GCOMObservation::GCOMObservation ( void )

Void constructor.

Creates an empty COMPTEL observation.

Definition at line 86 of file GCOMObservation.cpp.

References init_members().

Referenced by clone().

GCOMObservation::GCOMObservation ( const GXmlElement & xml )

explicit

XML constructor.

Parameters

[in] xml XML element.

Constructs a COMPTEL observation from the information that is found in an XML element.

Definition at line 104 of file GCOMObservation.cpp.

References init_members(), and read().

GCOMObservation::GCOMObservation	(	const GCOMDri &	dre,
		const GCOMDri &	drb,
		const GCOMDri &	drg,
		const GCOMDri &	drx
	)

Binned observation DRI constructor.

Parameters

[in]	dre	Event cube.
[in]	drb	Background cube.
[in]	drg	Geometry cube.
[in]	drx	Exposure map.

Creates COMPTEL observation from DRI instances.

The method fixes the deadtime correction factor deadc to 0.965.

Definition at line 129 of file GCOMObservation.cpp.

References drb(), drg(), drx(), GEvents::emax(), GEvents::emin(), GEvents::gti(), init_members(), m_deadc, m_drb, m_drbname, m_drename, m_drg, m_drgname, m_drx, m_drxname, GObservation::m_events, m_ewidth, m_livetime, GObservation::m_name, m_obs_id, m_ontime, and GEnergy::MeV().

GCOMObservation::GCOMObservation	(	const GFilename &	drename,
		const GFilename &	drbname,
		const GFilename &	drgname,
		const GFilename &	drxname
	)

Binned observation filename constructor.

Parameters

[in]	drename	Event cube name.
[in]	drbname	Background cube name.
[in]	drgname	Geometry cube name.
[in]	drxname	Exposure map name.

Creates COMPTEL observation by loading the following FITS files:

DRE - Events cube
DRB - Background model cube
DRG - Geometry factors cube
DRX - Exposure map

Each of the four files is mandatory.

Definition at line 177 of file GCOMObservation.cpp.

References init_members(), and load().

GCOMObservation::GCOMObservation	(	const GFilename &	evpname,
		const GFilename &	timname,
		const std::vector< GFilename > &	oadnames,
		const GFilename &	bvcname = `""`
	)

Unbinned observation constructor.

Parameters

[in]	evpname	Event list FITS file name.
[in]	timname	Good Time Intervals FITS file name.
[in]	oadnames	List of Orbit Aspect Data FITS file names.
[in]	bvcname	Solar System Barycentre Data FITS file name.

Creates a COMPTEL unbinned observation by loading the event list, Good Time Interval, Orbit Aspect Data and optionally the Solar System Barycentre Data from FITS files. Except of the Solar System Barycentre Data all files are mandatory. The Solar System Barycentre Data will only be loaded if the file name is not empty.

Definition at line 207 of file GCOMObservation.cpp.

References init_members(), and load().

GCOMObservation::GCOMObservation ( const GCOMObservation & obs )

Copy constructor.

Parameters

[in] obs COMPTEL observation.

Creates COMPTEL observation by copying an existing COMPTEL observation.

Definition at line 230 of file GCOMObservation.cpp.

References copy_members(), and init_members().

GCOMObservation::~GCOMObservation ( void )

virtual

Destructor.

Definition at line 246 of file GCOMObservation.cpp.

References free_members().

Member Function Documentation

const GCOMBvcs & GCOMObservation::bvcs ( void ) const

inline

Return Solar System Barycentre Data.

Returns: Solar System Barycentre Data

Definition at line 498 of file GCOMObservation.hpp.

References m_bvcs.

Referenced by bvcs(), and GCOMDri::compute_dre().

void GCOMObservation::bvcs ( const GCOMBvcs & bvcs )

inline

Set Solar System Barycentre Data.

Parameters

[in] bvcs Solar System Barycentre Data.

Definition at line 511 of file GCOMObservation.hpp.

References bvcs(), and m_bvcs.

bool GCOMObservation::check_dri ( const GCOMDri & dri ) const

protected

Check if DRI is compatible with event cube.

Parameters

[in] dri DRI.

Returns: True if DRI is compatible, false otherwise.

Compares the dimension and the WCS definition of a DRI to that of the event cube. If both are identical, true is returned, false otherwise.

Definition at line 1215 of file GCOMObservation.cpp.

References GObservation::m_events, GCOMDri::map(), GSkyMap::nmaps(), GSkyMap::nx(), GSkyMap::ny(), and GSkyMap::projection().

Referenced by compute_drb_bgdlixa(), compute_drb_bgdlixe(), compute_drb_phinor(), load_drb(), and load_drg().

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

inlinevirtual

Return class name.

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

Implements GObservation.

Definition at line 224 of file GCOMObservation.hpp.

void GCOMObservation::clear ( void )

virtual

Clear COMPTEL observation.

Implements GObservation.

Definition at line 303 of file GCOMObservation.cpp.

References GObservation::free_members(), free_members(), GObservation::init_members(), and init_members().

Referenced by load(), and read().

GCOMObservation * GCOMObservation::clone ( void ) const

virtual

Clone COMPTEL observation.

Returns: Pointer to deep copy of COMPTEL observation.

Implements GObservation.

Definition at line 323 of file GCOMObservation.cpp.

References GCOMObservation().

void GCOMObservation::compute_drb	(	const std::string &	method,
		const GCOMDri &	drm,
		const int &	nrunav = `3`,
		const int &	navgr = `3`,
		const int &	nincl = `13`,
		const int &	nexcl = `0`
	)

Compute DRB cube.

Parameters

[in]	method	Background method (PHINOR, BGDLIXA or BGDLIXE).
[in]	drm	DRM cube.
[in]	nrunav	BGDLIXA: number of bins used for running average.
[in]	navgr	BGDLIXA: number of bins used for averaging.
[in]	nincl	BGDLIXA: number of Phibar layers to include.
[in]	nexcl	BGDLIXA: number of Phibar layers to exclude.

Computes a COMPTEL DRB cube using either the PHINOR or BGDLIXA method. See the protected methods compute_drb_phinor() and compute_drb_bgdlixa() for more information.

Definition at line 815 of file GCOMObservation.cpp.

References compute_drb_bgdlixa(), compute_drb_bgdlixe(), compute_drb_phinor(), and G_COMPUTE_DRB.

void GCOMObservation::compute_drb_bgdlixa	(	const GCOMDri &	drm,
		const int &	nrunav = `3`,
		const int &	navgr = `3`,
		const int &	nincl = `13`,
		const int &	nexcl = `0`
	)

protected

Compute DRB cube using BGDLIXA method.

Parameters

[in]	drm	DRM cube.
[in]	nrunav	Number of bins used for running average.
[in]	navgr	Number of bins used for averaging.
[in]	nincl	Number of Phibar layers to include.
[in]	nexcl	Number of Phibar layers to exclude.

Exceptions

GException::invalid_value	Observation does not contain an event cube
GException::invalid_argument	DRM cube is incompatible with DRE

Computes a DRB cube using the BGDLIXA method that is documented in Rob van Dijk's PhD thesis. The revelant equations from the thesis that are implemented here are 3.12, 3.12 and 3.14.

Definition at line 1389 of file GCOMObservation.cpp.

References check_dri(), GCOMEventCube::dre(), GObservation::events(), G_COMPUTE_DRB_BGDLIXA, get_bgdlixa_phibar_indices(), get_weighted_drg_map(), GObservation::id(), m_drb, m_drg, GCOMDri::map(), GObservation::name(), GCOMDri::nchi(), norm(), GCOMDri::nphibar(), and GCOMDri::npsi().

Referenced by compute_drb().

void GCOMObservation::compute_drb_bgdlixe	(	const GCOMDri &	drm,
		const int &	nrunav = `3`,
		const int &	navgr = `3`,
		const int &	nincl = `13`,
		const int &	nexcl = `0`
	)

protected

Compute DRB cube using BGDLIXE method.

Parameters

[in]	drm	DRM cube.
[in]	nrunav	Number of bins used for running average.
[in]	navgr	Number of bins used for averaging.
[in]	nincl	Number of Phibar layers to include.
[in]	nexcl	Number of Phibar layers to exclude.

Exceptions

GException::invalid_value	Observation does not contain an event cube
GException::invalid_argument	DRM cube is incompatible with DRE

Computes a DRB cube using the BGDLIXE method. This method differs from the BGDLIXA method in the last step.

Definition at line 1740 of file GCOMObservation.cpp.

References check_dri(), GCOMEventCube::dre(), GObservation::events(), G_COMPUTE_DRB_BGDLIXE, get_bgdlixa_phibar_indices(), get_weighted_drg_map(), GObservation::id(), m_drb, m_drg, GCOMDri::map(), GObservation::name(), GCOMDri::nchi(), norm(), GCOMDri::nphibar(), and GCOMDri::npsi().

Referenced by compute_drb().

void GCOMObservation::compute_drb_phinor ( const GCOMDri & drm )

protected

Compute DRB cube using PHINOR method.

Parameters

[in] drm DRM cube.

Exceptions

GException::invalid_value	Observation does not contain an event cube
GException::invalid_argument	DRM cube is incompatible with DRE

Definition at line 1301 of file GCOMObservation.cpp.

References check_dri(), GCOMEventCube::dre(), GObservation::events(), G_COMPUTE_DRB_PHINOR, get_weighted_drg_map(), GObservation::id(), m_drb, m_drg, GCOMDri::map(), GObservation::name(), norm(), GCOMDri::nphibar(), and GSkyMap::npix().

Referenced by compute_drb().

void GCOMObservation::copy_members ( const GCOMObservation & obs )

protected

Copy class members.

Parameters

[in] obs COMPTEL observation.

Definition at line 982 of file GCOMObservation.cpp.

References m_bvcname, m_bvcs, m_deadc, m_drb, m_drbname, m_drename, m_drg, m_drgname, m_drx, m_drxname, m_evpname, m_ewidth, m_instrument, m_livetime, m_oadnames, m_oads, m_obs_id, m_ontime, m_phi_first, m_phi_last, m_response, m_tim, and m_timname.

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

double GCOMObservation::deadc ( const GTime & time = GTime() ) const

inlinevirtual

Return deadtime correction factor.

Parameters

[in] time Time.

Returns: Deadtime correction factor.

Implements GObservation.

Definition at line 303 of file GCOMObservation.hpp.

References m_deadc.

Referenced by deadc(), GCOMResponse::irf_diffuse(), GCOMResponse::irf_elliptical(), GCOMResponse::irf_ptsrc(), and GCOMResponse::irf_radial().

void GCOMObservation::deadc ( const double & deadc )

inline

Set deadtime correction factor.

Parameters

[in] deadc Deadtime correction factor.

Definition at line 355 of file GCOMObservation.hpp.

References deadc(), and m_deadc.

const GCOMDri & GCOMObservation::drb ( void ) const

inline

Return background model.

Returns: Background model.

Definition at line 407 of file GCOMObservation.hpp.

References m_drb.

Referenced by GCOMModelDRBPhibarBins::eval(), GCOMModelDRBPhibarNodes::eval(), and GCOMObservation().

const GFilename & GCOMObservation::drbname ( void ) const

inline

Return DRB filename.

Returns: DRB filename.

Definition at line 561 of file GCOMObservation.hpp.

References m_drbname.

Referenced by drbname(), load_drb(), and read().

void GCOMObservation::drbname ( const GFilename & drbname )

inline

Set DRB filename.

Parameters

[in] drbname DRB filename.

Definition at line 639 of file GCOMObservation.hpp.

References drbname(), and m_drbname.

const GFilename & GCOMObservation::drename ( void ) const

inline

Return DRE filename.

Returns: DRE filename.

Definition at line 548 of file GCOMObservation.hpp.

References m_drename.

Referenced by drename(), load_dre(), and read().

void GCOMObservation::drename ( const GFilename & drename )

inline

Set DRE filename.

Parameters

[in] drename DRE filename.

Definition at line 626 of file GCOMObservation.hpp.

References drename(), and m_drename.

const GCOMDri & GCOMObservation::drg ( void ) const

inline

Return geometry factors.

Returns: Geometry factors.

Definition at line 420 of file GCOMObservation.hpp.

References m_drg.

Referenced by GCOMObservation(), get_weighted_drg_map(), GCOMResponse::irf(), GCOMResponse::irf_diffuse(), GCOMResponse::irf_elliptical(), GCOMResponse::irf_ptsrc(), and GCOMResponse::irf_radial().

const GFilename & GCOMObservation::drgname ( void ) const

inline

Return DRG filename.

Returns: DRG filename.

Definition at line 574 of file GCOMObservation.hpp.

References m_drgname.

Referenced by drgname(), load_drg(), and read().

void GCOMObservation::drgname ( const GFilename & drgname )

inline

Set DRG filename.

Parameters

[in] drgname DRG filename.

Definition at line 652 of file GCOMObservation.hpp.

References drgname(), and m_drgname.

GCOMDri GCOMObservation::drm ( const GModels & models ) const

Compute DRM cube.

Parameters

[in] models Model container.

Returns: DRM cube (units of counts)

Exceptions

GException::invalid_value Observation does not contain an event cube.

Computes a COMPTEL DRM cube from the information provided in a model container. The values of the DRM cube are in units of counts.

Definition at line 761 of file GCOMObservation.cpp.

References GCOMEventBin::counts(), GCOMEventCube::dre(), GModels::eval(), G_DRM, GObservation::m_events, GObservation::model(), GObservation::name(), GCOMEventBin::size(), and GCOMEventCube::size().

const GCOMDri & GCOMObservation::drx ( void ) const

inline

Return exposure.

Returns: Exposure.

Definition at line 433 of file GCOMObservation.hpp.

References m_drx.

Referenced by GCOMObservation(), GCOMResponse::irf(), GCOMResponse::irf_diffuse(), GCOMResponse::irf_elliptical(), GCOMResponse::irf_ptsrc(), and GCOMResponse::irf_radial().

const GFilename & GCOMObservation::drxname ( void ) const

inline

Return DRX filename.

Returns: DRX filename.

Definition at line 587 of file GCOMObservation.hpp.

References m_drxname.

Referenced by drxname(), load_drx(), and read().

void GCOMObservation::drxname ( const GFilename & drxname )

inline

Set DRX filename.

Parameters

[in] drxname DRX filename.

Definition at line 665 of file GCOMObservation.hpp.

References drxname(), and m_drxname.

void GCOMObservation::ewidth ( const double & ewidth )

inline

Set energy width.

Parameters

[in] ewidth Energy width (MeV).

Definition at line 368 of file GCOMObservation.hpp.

References ewidth(), and m_ewidth.

const double & GCOMObservation::ewidth ( void ) const

inline

Return energy width.

Returns: Energy width (MeV).

Definition at line 394 of file GCOMObservation.hpp.

References m_ewidth.

Referenced by ewidth().

void GCOMObservation::free_members ( void )

protected

Delete class members.

Definition at line 1021 of file GCOMObservation.cpp.

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

void GCOMObservation::get_bgdlixa_phibar_indices	(	const int &	iphibar,
		const int &	nincl,
		const int &	nexcl,
		int *	isel1,
		int *	iex1,
		int *	iex2,
		int *	isel2
	)		const

protected

Compute Phibar index range for BGDLIXA background method.

Parameters

[in]	iphibar	Phibar layer index.
[in]	nincl	Number of Phibar layers to include.
[in]	nexcl	Number of Phibar layers to exclude.
[out]	isel1	Start index for first sum.
[out]	iex1	Stop index for first sum.
[out]	iex2	Start index for second sum.
[out]	isel2	Stop index for second sum.

This method is a helper method for the BGDLIXA background method. It computes the Phibar index range for the third step of the background model computation. The third step corresponds to Equation (3.14) in Rob van Dijk's PhD thesis.

The Phibar sum will be taken over the index ranges [isel1, iex1] and [ixe2, isel2].

Definition at line 1982 of file GCOMObservation.cpp.

References m_drg, and GCOMDri::nphibar().

Referenced by compute_drb_bgdlixa(), and compute_drb_bgdlixe().

GSkyMap GCOMObservation::get_weighted_drg_map ( void ) const

protected

Return weighted DRG map.

Returns: Weighted DRG map.

Returns a DRG as sky map where each pixel of the map is multiplied by the solidangle of the pixel.

Definition at line 1941 of file GCOMObservation.cpp.

References drg(), m_drg, GCOMDri::map(), GSkyMap::nmaps(), GSkyMap::npix(), and GSkyMap::solidangle().

Referenced by compute_drb_bgdlixa(), compute_drb_bgdlixe(), and compute_drb_phinor().

void GCOMObservation::init_members ( void )

protected

Initialise class members.

Definition at line 941 of file GCOMObservation.cpp.

References GCOMTim::clear(), GCOMOads::clear(), GCOMBvcs::clear(), GCOMResponse::clear(), GCOMDri::clear(), GFilename::clear(), m_bvcname, m_bvcs, m_deadc, m_drb, m_drbname, m_drename, m_drg, m_drgname, m_drx, m_drxname, m_evpname, m_ewidth, m_instrument, m_livetime, m_oadnames, m_oads, m_obs_id, m_ontime, m_phi_first, m_phi_last, m_response, m_tim, and m_timname.

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

std::string GCOMObservation::instrument ( void ) const

inlinevirtual

Return instrument.

Returns: Instrument name.

Implements GObservation.

Definition at line 262 of file GCOMObservation.hpp.

References m_instrument.

Referenced by print().

bool GCOMObservation::is_binned ( void ) const

inline

Check whether observation is binned.

Returns: True if observation is unbinned.

Definition at line 536 of file GCOMObservation.hpp.

References GObservation::m_events.

Referenced by write().

bool GCOMObservation::is_unbinned ( void ) const

inline

Check whether observation is unbinned.

Returns: True if observation is unbinned.

Definition at line 524 of file GCOMObservation.hpp.

References GObservation::m_events.

Referenced by write().

double GCOMObservation::livetime ( void ) const

inlinevirtual

Return livetime.

Returns: Livetime (seconds).

Implements GObservation.

Definition at line 288 of file GCOMObservation.hpp.

References m_livetime.

Referenced by livetime(), and print().

void GCOMObservation::livetime ( const double & livetime )

inline

Set livetime.

Parameters

[in] livetime Livetime.

Definition at line 342 of file GCOMObservation.hpp.

References livetime(), and m_livetime.

void GCOMObservation::load	(	const GFilename &	drename,
		const GFilename &	drbname,
		const GFilename &	drgname,
		const GFilename &	drxname
	)

Load data for a binned observation.

Parameters

[in]	drename	Event cube name.
[in]	drbname	Background cube name.
[in]	drgname	Geometry cube name.
[in]	drxname	Exposure map name.

Load event cube from DRE file, background model from DRB file, geometry factors from DRG file and the exposure map from the DRX file. All files are mandatory.

Definition at line 633 of file GCOMObservation.cpp.

References load_drb(), load_dre(), load_drg(), and load_drx().

Referenced by GCOMObservation(), and read().

void GCOMObservation::load	(	const GFilename &	evpname,
		const GFilename &	timname,
		const std::vector< GFilename > &	oadnames,
		const GFilename &	bvcname = `""`
	)

Load data for an unbinned observation.

Parameters

[in]	evpname	Event list FITS file name.
[in]	timname	Good Time Intervals FITS file name.
[in]	oadnames	List of Orbit Aspect Data FITS file names.
[in]	bvcname	Solar System Barycentre Data FITS file name.

Loads the event list, Good Time Interval, Orbit Aspect Data and optionally the Solar System Barycentre Data for an unbinned observation. Except of the Solar System Barycentre Data all files are mandatory. The Solar System Barycentre Data will only be loaded if the file name is not empty.

The method fixes the deadtime correction factor deadc to 0.965.

Definition at line 670 of file GCOMObservation.cpp.

References clear(), GFits::close(), GCOMOads::extend(), GCOMTim::gti(), GCOMTim::load(), GCOMBvcs::load(), m_bvcname, m_bvcs, m_deadc, GObservation::m_events, m_evpname, m_livetime, m_oadnames, m_oads, m_ontime, m_tim, m_timname, oads(), GGti::ontime(), read_attributes(), and GCOMOads::size().

void GCOMObservation::load_drb ( const GFilename & drbname )

protected

Load background model from DRB file.

Parameters

[in] drbname DRB filename.

Exceptions

GException::invalid_value DRB data space incompatible with DRE data space.

Load the background model from the primary image of the specified FITS file. Since a DRB file is optional the method does nothing if the DRB filename is empty.

Definition at line 1094 of file GCOMObservation.cpp.

References check_dri(), GFits::close(), gammalib::com_wcs_mer2car(), drbname(), G_LOAD_DRB, GFits::image(), GFilename::is_empty(), m_drb, m_drbname, m_drename, GCOMDri::map(), and GCOMDri::read().

Referenced by load().

void GCOMObservation::load_dre ( const GFilename & drename )

protected

Load event cube data from DRE file.

Parameters

[in] drename DRE filename.

Loads the event cube from a DRE file.

The ontime is extracted from the Good Time Intervals. The deadtime correction factor deadc is fixed to 0.965. The livetime is computed by multiplying the deadtime correction by the ontime, i.e. LIVETIME = ONTIME * DEADC.

Definition at line 1040 of file GCOMObservation.cpp.

References GFits::close(), drename(), GEvents::emax(), GEvents::emin(), GEvents::gti(), m_deadc, m_drename, GObservation::m_events, m_ewidth, m_livetime, m_ontime, GEnergy::MeV(), GEvents::read(), and read_attributes().

Referenced by load().

void GCOMObservation::load_drg ( const GFilename & drgname )

protected

Load geometry factors from DRG file.

Parameters

[in] drgname DRG filename.

Exceptions

GException::invalid_value DRG data space incompatible with DRE data space.

Load the geometry factors from the primary image of the specified FITS file.

Definition at line 1142 of file GCOMObservation.cpp.

References check_dri(), GFits::close(), gammalib::com_wcs_mer2car(), drgname(), G_LOAD_DRB, GFits::image(), m_drename, m_drg, m_drgname, GCOMDri::map(), and GCOMDri::read().

Referenced by load().

void GCOMObservation::load_drx ( const GFilename & drxname )

protected

Load exposure from DRX file.

Parameters

[in] drxname DRX filename.

Load the exposure map from the primary image of the specified FITS file.

Definition at line 1181 of file GCOMObservation.cpp.

References GFits::close(), gammalib::com_wcs_mer2car(), drxname(), GFits::image(), m_drx, m_drxname, GCOMDri::map(), and GCOMDri::read().

Referenced by load().

const GCOMOads & GCOMObservation::oads ( void ) const

inline

Return Orbit Aspect Data.

Returns: Orbit Aspect Data

Definition at line 472 of file GCOMObservation.hpp.

References m_oads.

Referenced by GCOMDri::compute_dre(), GCOMDri::compute_drg(), GCOMDri::compute_drx(), load(), and oads().

void GCOMObservation::oads ( const GCOMOads & oads )

inline

Set Orbit Aspect Data.

Parameters

[in] oads Orbit Aspect Data.

Definition at line 485 of file GCOMObservation.hpp.

References m_oads, and oads().

void GCOMObservation::obs_id ( const double & id )

inline

Set observation ID.

Parameters

[in] id Observation ID.

Definition at line 316 of file GCOMObservation.hpp.

References GObservation::id(), and m_obs_id.

const double & GCOMObservation::obs_id ( void ) const

inline

Return observation ID.

Returns: Observation ID.

Definition at line 381 of file GCOMObservation.hpp.

References m_obs_id.

double GCOMObservation::ontime ( void ) const

inlinevirtual

Return ontime.

Returns: Ontime (seconds).

Implements GObservation.

Definition at line 275 of file GCOMObservation.hpp.

References m_ontime.

Referenced by GCOMResponse::irf(), GCOMResponse::irf_diffuse(), GCOMResponse::irf_elliptical(), GCOMResponse::irf_ptsrc(), GCOMResponse::irf_radial(), ontime(), and print().

void GCOMObservation::ontime ( const double & ontime )

inline

Set ontime.

Parameters

[in] ontime Ontime.

Definition at line 329 of file GCOMObservation.hpp.

References m_ontime, and ontime().

GCOMObservation & GCOMObservation::operator= ( const GCOMObservation & obs )

virtual

Assignment operator.

Parameters

[in] obs COMPTEL observation.

Returns: COMPTEL observation.

Assign COMPTEL observation to this object.

Definition at line 270 of file GCOMObservation.cpp.

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

const int & GCOMObservation::phi_first ( void ) const

inline

Return index of first Phibar layer to be used for likelihood fitting.

Returns: Index of first Phibar layer.

Definition at line 600 of file GCOMObservation.hpp.

References m_phi_first.

Referenced by phi_first(), and print().

void GCOMObservation::phi_first ( const int & phi_first )

inline

Set index of first Phibar layer to be used for likelihood fitting.

Parameters

[in] phi_first Index of first Phibar layer.

Definition at line 678 of file GCOMObservation.hpp.

References m_phi_first, and phi_first().

const int & GCOMObservation::phi_last ( void ) const

inline

Return index of last Phibar layer to be used for likelihood fitting.

Returns: Index of last Phibar layer.

Definition at line 613 of file GCOMObservation.hpp.

References m_phi_last.

Referenced by phi_last(), and print().

void GCOMObservation::phi_last ( const int & phi_last )

inline

Set index of last Phibar layer to be used for likelihood fitting.

Parameters

[in] phi_last Index of last Phibar layer.

Definition at line 691 of file GCOMObservation.hpp.

References m_phi_last, and phi_last().

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

virtual

Print observation information.

Parameters

[in] chatter Chattiness.

Returns: String containing observation information.

Implements GObservation.

Definition at line 850 of file GCOMObservation.cpp.

References GCOMTim::gti(), instrument(), GCOMOads::is_empty(), GCOMBvcs::is_empty(), livetime(), m_bvcs, m_deadc, m_drg, GObservation::m_events, m_oads, m_phi_first, m_phi_last, m_tim, GCOMDri::map(), GObservation::name(), GSkyMap::nmaps(), ontime(), gammalib::parformat(), phi_first(), phi_last(), GCOMTim::print(), GCOMOads::print(), GCOMBvcs::print(), GEvents::print(), gammalib::reduce(), response(), SILENT, GGti::size(), GObservation::statistic(), and gammalib::str().

void GCOMObservation::read ( const GXmlElement & xml )

virtual

Read observation from XML element.

Parameters

[in] xml XML element.

Reads information for a COMPTEL observation from an XML element. The method supports both an unbinned and a binned observation.

For an unbinned observation the XML format is

<observation name="Crab" id="000001" instrument="COM">
  <parameter name="EVP" file="m16992_evp.fits"/>
  <parameter name="TIM" file="m10695_tim.fits"/>
  <parameter name="OAD" file="m20039_oad.fits"/>
  <parameter name="OAD" file="m20041_oad.fits"/>
  <parameter name="BVC" file="s10150_bvc.fits"/>
  ...
</observation>

where the observation can contain an arbitrary number of OAD file parameters. The file attribute provide either absolute or relative file names. If a file name includes no access path it is assumed that the file resides in the same location as the XML file. The BVC file is optional and does not need to be specified.

For a binned observation the XML format is

<observation name="Crab" id="000001" instrument="COM">
  <parameter name="DRE" file="m50438_dre.fits"/>
  <parameter name="DRB" file="m34997_drg.fits"/>
  <parameter name="DRG" file="m34997_drg.fits"/>
  <parameter name="DRX" file="m32171_drx.fits"/>
  <parameter name="IAQ" value="UNH(1.0-3.0)MeV"/>
</observation>

Implements GObservation.

Definition at line 419 of file GCOMObservation.cpp.

References GXmlElement::attribute(), clear(), drbname(), drename(), drgname(), drxname(), GXmlNode::element(), GXmlNode::elements(), G_READ, GXmlElement::has_attribute(), GFilename::is_fits(), load(), m_instrument, m_phi_first, m_phi_last, response(), gammalib::toint(), gammalib::xml_file_expand(), gammalib::xml_get_attr(), and gammalib::xml_has_par().

Referenced by GCOMObservation().

void GCOMObservation::read_attributes ( const GFitsHDU * hdu )

protected

Read observation attributes.

Parameters

[in] hdu FITS HDU pointer

Reads optional attributes are

OBS_ID   - Observation identifier
OBJECT   - Object

Nothing is done if the HDU pointer is NULL.

Definition at line 1254 of file GCOMObservation.cpp.

References GFitsHDU::has_card(), GObservation::m_name, m_obs_id, GFitsHDU::real(), and GFitsHDU::string().

Referenced by load(), and load_dre().

void GCOMObservation::response ( const GResponse & rsp )

virtual

Set response function.

Parameters

[in] rsp Response function.

Exceptions

GException::invalid_argument Specified response is not a COMPTEL response.

Sets the response function for the observation.

Implements GObservation.

Definition at line 339 of file GCOMObservation.cpp.

References G_RESPONSE, m_response, and GObservation::name().

const GCOMResponse * GCOMObservation::response ( void ) const

inlinevirtual

Return response function.

Returns: Response function.

Implements GObservation.

Definition at line 236 of file GCOMObservation.hpp.

References m_response.

Referenced by print(), read(), and response().

void GCOMObservation::response	(	const GCaldb &	caldb,
		const std::string &	rspname
	)

Set response function.

Parameters

[in]	caldb	Calibration database.
[in]	rspname	Name of COMPTEL response.

Sets the response function by loading the response information from the calibration database.

Definition at line 368 of file GCOMObservation.cpp.

References GCOMResponse::caldb(), GCOMResponse::clear(), GCOMResponse::load(), and m_response.

void GCOMObservation::response ( const GCOMResponse & response )

inline

Set response function.

Parameters

[in] response Response function.

Definition at line 249 of file GCOMObservation.hpp.

References m_response, and response().

const GCOMTim & GCOMObservation::tim ( void ) const

inline

Return COMPTEL Good Time Intervals.

Returns: COMPTEL Good Time Intervals.

Definition at line 446 of file GCOMObservation.hpp.

References m_tim.

Referenced by GCOMDri::compute_dre(), GCOMDri::compute_drg(), GCOMDri::compute_drx(), and tim().

void GCOMObservation::tim ( const GCOMTim & tim )

inline

Set COMPTEL Good Time Intervals.

Parameters

[in] tim COMPTEL Good Time Intervals.

Definition at line 459 of file GCOMObservation.hpp.

References m_tim, and tim().

bool GCOMObservation::use_event_for_likelihood ( const int & index ) const

protectedvirtual

Check whether bin should be used for likelihood analysis.

Parameters

[in] index Event index.

Returns: True if event with specified index should be used.

Implements the Phibar event selection.

Reimplemented from GObservation.

Definition at line 2048 of file GCOMObservation.cpp.

References m_drg, m_phi_first, m_phi_last, GCOMDri::map(), and GSkyMap::npix().

void GCOMObservation::write ( GXmlElement & xml ) const

virtual

Write observation into XML element.

Parameters

[in] xml XML element.

Writes information for a COMPTEL observation into an XML element. The method supports both an unbinned and a binned observation.

For an unbinned observation the XML format is

<observation name="Crab" id="000001" instrument="COM">
  <parameter name="EVP" file="m16992_evp.fits"/>
  <parameter name="TIM" file="m10695_tim.fits"/>
  <parameter name="OAD" file="m20039_oad.fits"/>
  <parameter name="OAD" file="m20041_oad.fits"/>
  <parameter name="BVC" file="s10150_bvc.fits"/>
  ...
</observation>

where the observation can contain an arbitrary number of OAD file parameters. The file attribute provide either absolute or relative file names. If a file name includes no access path it is assumed that the file resides in the same location as the XML file. The BVC file is optional and is only written if BVC information is contained in the observation.

For a binned observation the XML format is

<observation name="Crab" id="000001" instrument="COM">
  <parameter name="DRE" file="m50438_dre.fits"/>
  <parameter name="DRB" file="m34997_drg.fits"/>
  <parameter name="DRG" file="m34997_drg.fits"/>
  <parameter name="DRX" file="m32171_drx.fits"/>
  <parameter name="IAQ" value="UNH(1.0-3.0)MeV"/>
</observation>

Implements GObservation.

Definition at line 543 of file GCOMObservation.cpp.

References GXmlNode::append(), GXmlElement::attribute(), GXmlNode::element(), GXmlNode::elements(), G_WRITE, is_binned(), GCOMBvcs::is_empty(), is_unbinned(), m_bvcname, m_bvcs, m_drbname, m_drename, m_drgname, m_drxname, m_evpname, m_oadnames, m_phi_first, m_phi_last, m_response, m_timname, GXmlNode::remove(), GCOMResponse::rspname(), gammalib::str(), gammalib::xml_file_reduce(), and gammalib::xml_need_par().