Multi-wavelength response class. More...

#include <GMWLResponse.hpp>

Inheritance diagram for GMWLResponse:

Public Member Functions
	GMWLResponse (void)
	Void constructor.

	GMWLResponse (const GMWLResponse &rsp)
	Copy constructor.

virtual	~GMWLResponse (void)
	Destructor.

virtual GMWLResponse &	operator= (const GMWLResponse &rsp)
	Assignment operator.

virtual void	clear (void)
	Clear instance.

virtual GMWLResponse *	clone (void) const
	Clone instance.

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

virtual bool	use_edisp (void) const
	Signal if response uses energy dispersion.

virtual bool	use_tdisp (void) const
	Signal if response uses time dispersion.

virtual double	irf (const GEvent &event, const GPhoton &photon, const GObservation &obs) const
	Return instrument response function.

virtual double	nroi (const GModelSky &model, const GEnergy &obsEng, const GTime &obsTime, const GObservation &obs) const
	Return integral of event probability for a given sky model over ROI.

virtual GEbounds	ebounds (const GEnergy &obsEnergy) const
	Return true energy boundaries for a specific observed energy.

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

virtual double	irf_spatial (const GEvent &event, const GSource &source, const GObservation &obs) const
	Return instrument response function.

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

	GResponse (const GResponse &rsp)
	Copy constructor.

virtual	~GResponse (void)
	Destructor.

virtual GResponse &	operator= (const GResponse &rsp)
	Assignment operator.

virtual double	convolve (const GModelSky &model, const GEvent &event, const GObservation &obs, const bool &grad=true) const
	Convolve sky model with the instrument response.

virtual GVector	convolve (const GModelSky &model, const GObservation &obs, GMatrixSparse *gradients=NULL) const
	Convolve sky model with the instrument response.

virtual GVector	irf_spatial (const GModelSky &model, const GObservation &obs, GMatrix *gradients=NULL) const
	Return instrument response vector integrated over the spatial model.

virtual void	remove_response_cache (const std::string &cache_id)
	Remove response cache for specific observation and model.

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

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

void	copy_members (const GMWLResponse &pnt)
	Copy class members.

void	free_members (void)
	Delete class members.

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

void	copy_members (const GResponse &rsp)
	Copy class members.

void	free_members (void)
	Delete class members.

double	eval_prob (const GModelSky &model, const GEvent &event, const GEnergy &srcEng, const GTime &srcTime, const GObservation &obs, const bool &grad) const
	Convolve sky model with the instrument response.

GVector	eval_probs (const GModelSky &model, const GObservation &obs, GMatrixSparse *gradients=NULL) const
	Convolve sky model with the instrument response.

int	size_edisp_vector (const GModelSky &model, const GObservation &obs, const bool &grad) const
	Return size of vector for energy dispersion computation.

GEbounds	ebounds_model (const GModelSky &model) const
	Return true energy intervals for sky model.

virtual double	irf_ptsrc (const GEvent &event, const GSource &source, const GObservation &obs) const
	Return instrument response to point source.

virtual double	irf_radial (const GEvent &event, const GSource &source, const GObservation &obs) const
	Return instrument response to radial source.

virtual double	irf_elliptical (const GEvent &event, const GSource &source, const GObservation &obs) const
	Return instrument response to elliptical source.

virtual double	irf_diffuse (const GEvent &event, const GSource &source, const GObservation &obs) const
	Return instrument response to diffuse source.

virtual double	irf_composite (const GEvent &event, const GSource &source, const GObservation &obs) const
	Return instrument response to composite source.

virtual GVector	irf_ptsrc (const GModelSky &model, const GObservation &obs, GMatrix *gradients=NULL) const
	Return instrument response to point source sky model.

virtual GVector	irf_radial (const GModelSky &model, const GObservation &obs, GMatrix *gradients=NULL) const
	Return instrument response to radial source sky model.

virtual GVector	irf_elliptical (const GModelSky &model, const GObservation &obs, GMatrix *gradients=NULL) const
	Return instrument response to ellipitical source sky model.

virtual GVector	irf_diffuse (const GModelSky &model, const GObservation &obs, GMatrix *gradients=NULL) const
	Return instrument response to diffuse source sky model.

virtual GVector	irf_composite (const GModelSky &model, const GObservation &obs, GMatrix *gradients=NULL) const
	Return instrument response to composite source sky model.

Additional Inherited Members
Protected Attributes inherited from GResponse
bool	m_use_irf_cache
	Control usage of irf cache.

bool	m_use_nroi_cache
	Control usage of nroi cache.

int	m_irf_radial_iter_theta
	Radial model integration theta iterations.

int	m_irf_radial_iter_phi
	Radial model integration phi iterations.

int	m_irf_elliptical_iter_theta
	Elliptical model integration theta iterations.

int	m_irf_elliptical_iter_phi
	Elliptical model integration phi iterations.

double	m_irf_diffuse_resolution
	Angular resolution for diffuse model.

GResponseCache	m_irf_cache

GResponseCache	m_nroi_cache

GResponseVectorCache	m_irf_vector_cache

Detailed Description

Multi-wavelength response class.

This class implements a dummy response class for multi-wavelength observations. Since the multi-wavelength instrument classes handles data that a provided in photon space, no instrument response is in fact needed. The dummy response implemented by this class provides a simple diagonal response matrix that allows integration of multi-wavelength observations using the standard instrument specific interface.

Definition at line 55 of file GMWLResponse.hpp.

Constructor & Destructor Documentation

◆ GMWLResponse() [1/2]

GMWLResponse::GMWLResponse ( void )

Void constructor.

Definition at line 56 of file GMWLResponse.cpp.

References init_members().

Referenced by clone().

◆ GMWLResponse() [2/2]

GMWLResponse::GMWLResponse ( const GMWLResponse & rsp )

Copy constructor.

Parameters

[in] rsp Response.

Definition at line 71 of file GMWLResponse.cpp.

References copy_members(), and init_members().

◆ ~GMWLResponse()

GMWLResponse::~GMWLResponse ( void )

virtual

Destructor.

Definition at line 87 of file GMWLResponse.cpp.

References free_members().

Member Function Documentation

◆ classname()

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

inlinevirtual

Return class name.

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

Implements GResponse.

Definition at line 101 of file GMWLResponse.hpp.

◆ clear()

void GMWLResponse::clear ( void )

virtual

Clear instance.

Implements GResponse.

Definition at line 141 of file GMWLResponse.cpp.

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

Referenced by GMWLObservation::init_members().

◆ clone()

GMWLResponse * GMWLResponse::clone ( void ) const

virtual

Clone instance.

Implements GResponse.

Definition at line 159 of file GMWLResponse.cpp.

References GMWLResponse().

◆ copy_members()

void GMWLResponse::copy_members ( const GMWLResponse & rsp )

protected

Copy class members.

Parameters

[in] rsp Response.

Definition at line 264 of file GMWLResponse.cpp.

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

◆ ebounds()

GEbounds GMWLResponse::ebounds ( const GEnergy & obsEnergy ) const

virtual

Return true energy boundaries for a specific observed energy.

Parameters

[in] obsEnergy Observed Energy.

Returns: True energy boundaries for given observed energy.

Exceptions

GException::feature_not_implemented Method is not implemented.

Implements GResponse.

Definition at line 201 of file GMWLResponse.cpp.

References ebounds(), and G_EBOUNDS.

Referenced by ebounds().

◆ free_members()

void GMWLResponse::free_members ( void )

protected

Delete class members.

Definition at line 274 of file GMWLResponse.cpp.

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

◆ init_members()

void GMWLResponse::init_members ( void )

protected

Initialise class members.

Definition at line 252 of file GMWLResponse.cpp.

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

◆ irf()

double GMWLResponse::irf	(	const GEvent &	event,
		const GPhoton &	photon,
		const GObservation &	obs ) const

inlinevirtual

Return instrument response function.

Parameters

[in]	event	Event.
[in]	photon	Photon.
[in]	obs	Observation.

Returns: Instrument response function (always 1).

Implements GResponse.

Definition at line 141 of file GMWLResponse.hpp.

◆ irf_spatial()

double GMWLResponse::irf_spatial	(	const GEvent &	event,
		const GSource &	source,
		const GObservation &	obs ) const

inlinevirtual

Return instrument response function.

Parameters

[in]	event	Event.
[in]	source	Source.
[in]	obs	Observation.

Returns: Instrument response function (always 1).

Reimplemented from GResponse.

Definition at line 159 of file GMWLResponse.hpp.

◆ nroi()

double GMWLResponse::nroi	(	const GModelSky &	model,
		const GEnergy &	obsEng,
		const GTime &	obsTime,
		const GObservation &	obs ) const

virtual

Return integral of event probability for a given sky model over ROI.

Parameters

[in]	model	Sky model.
[in]	obsEng	Observed photon energy.
[in]	obsTime	Observed photon arrival time.
[in]	obs	Observation.

Returns: 0.0

Exceptions

GException::feature_not_implemented Method is not implemented.

Implements GResponse.

Definition at line 177 of file GMWLResponse.cpp.

References G_NROI.

◆ operator=()

GMWLResponse & GMWLResponse::operator= ( const GMWLResponse & rsp )

virtual

Assignment operator.

Parameters

[in] rsp Response.

Definition at line 108 of file GMWLResponse.cpp.

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

◆ print()

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

virtual

Print response information.

Parameters

[in] chatter Chattiness (defaults to NORMAL).

Returns: String containing response information

Implements GResponse.

Definition at line 221 of file GMWLResponse.cpp.

References SILENT.

◆ use_edisp()

bool GMWLResponse::use_edisp ( void ) const

inlinevirtual

Signal if response uses energy dispersion.

Returns: True if response uses energy dispersion.

Implements GResponse.

Definition at line 113 of file GMWLResponse.hpp.

◆ use_tdisp()

bool GMWLResponse::use_tdisp ( void ) const

inlinevirtual

Signal if response uses time dispersion.

Returns: True if response uses time dispersion.

Implements GResponse.

Definition at line 125 of file GMWLResponse.hpp.

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

inst/mwl/include/GMWLResponse.hpp
inst/mwl/src/GMWLResponse.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GMWLResponse() [1/2]

◆ GMWLResponse() [2/2]

◆ ~GMWLResponse()

Member Function Documentation

◆ classname()

◆ clear()

◆ clone()

◆ copy_members()

◆ ebounds()

◆ free_members()

◆ init_members()

◆ irf()

◆ irf_spatial()

◆ nroi()

◆ operator=()

◆ print()

◆ use_edisp()

◆ use_tdisp()