Abstract spatial model base class. More...

#include <GModelSpatial.hpp>

Inheritance diagram for GModelSpatial:

Classes
class	circle_int_kern_omega

class	circle_int_kern_rho

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

	GModelSpatial (const GModelSpatial &model)
	Copy constructor. More...

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

virtual GModelSpatial &	operator= (const GModelSpatial &model)
	Assignment operator. More...

virtual GModelPar &	operator[] (const int &index)
	Returns model parameter. More...

virtual const GModelPar &	operator[] (const int &index) const
	Returns model parameter (const version) More...

virtual GModelPar &	operator[] (const std::string &name)
	Returns model parameter. More...

virtual const GModelPar &	operator[] (const std::string &name) const
	Returns model parameter (const version) More...

virtual void	clear (void)=0
	Clear object. More...

virtual GModelSpatial *	clone (void) const =0
	Clones object. More...

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

virtual GClassCode	code (void) const =0

virtual double	eval (const GPhoton &photon, const bool &gradients=false) const =0

virtual GSkyDir	mc (const GEnergy &energy, const GTime &time, GRan &ran) const =0

virtual double	mc_norm (const GSkyDir &dir, const double &radius) const =0

virtual bool	contains (const GSkyDir &dir, const double &margin=0.0) const =0

virtual void	read (const GXmlElement &xml)=0

virtual void	write (GXmlElement &xml) const =0

virtual std::string	print (const GChatter &chatter=NORMAL) const =0
	Print content of object. More...

virtual double	flux (const GSkyRegion &region, const GEnergy &srcEng=GEnergy(), const GTime &srcTime=GTime()) const
	Returns model flux within sky region. More...

std::string	type (void) const
	Return model type. More...

void	type (const std::string &type)
	Set model type. More...

GModelPar &	at (const int &index)
	Returns model parameter. More...

const GModelPar &	at (const int &index) const
	Returns model parameter (const version) More...

bool	has_par (const std::string &name) const
	Checks if parameter name exists. More...

bool	has_free_pars (void) const
	Checks if the spatial model has free parameters. More...

int	size (void) const
	Return number of parameters. More...

void	autoscale (void)
	Autoscale parameters. More...

const GSkyRegion *	region (void) const
	Return boundary sky region. 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 GModelSpatial &model)
	Copy class members. More...

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

virtual void	set_region (void) const =0

Protected Attributes
std::string	m_type
	Spatial model type. More...

GSkyRegionCircle	m_region
	Bounding circle. More...

std::vector< GModelPar * >	m_pars
	Parameter pointers. More...

Detailed Description

Abstract spatial model base class.

This class implements the spatial component of the factorized gamma-ray source model. The spatial component is given by

\[ S_{\rm p}(\vec{p} | E, t) \]

where

\(\vec{p}\) is the true photon arrival direction,
\(E\) is the true photon energy, and
\(t\) is the true photon arrival time.

The spatial component describes the energy and time dependent morphology of the source. It satisfies

\[ \int_{\Omega} S_{\rm p}(\vec{p} | E, t) d\Omega = 1 \]

for all \(E\) and \(t\), hence the spatial component does not impact the spatially integrated spectral and temporal properties of the source.

Definition at line 75 of file GModelSpatial.hpp.

Constructor & Destructor Documentation

GModelSpatial::GModelSpatial ( void )

Void constructor.

Definition at line 59 of file GModelSpatial.cpp.

References init_members().

GModelSpatial::GModelSpatial ( const GModelSpatial & model )

Copy constructor.

Parameters

[in] model Spatial model.

Definition at line 74 of file GModelSpatial.cpp.

References copy_members(), and init_members().

GModelSpatial::~GModelSpatial ( void )

virtual

Destructor.

Definition at line 90 of file GModelSpatial.cpp.

References free_members().

Member Function Documentation

GModelPar & GModelSpatial::at ( const int & index )

Returns model parameter.

Parameters

[in] index Parameter index [0,...,size()[.

Returns: Model parameter.

Exceptions

GException::out_of_range Parameter index is out of range.

Returns model parameter with index range checking.

Definition at line 216 of file GModelSpatial.cpp.

References G_AT, m_pars, and size().

const GModelPar & GModelSpatial::at ( const int & index ) const

Returns model parameter (const version)

Parameters

[in] index Parameter index [0,...,size()[.

Returns: Model parameter.

Exceptions

GException::out_of_range Parameter index is out of range.

Returns model parameter with index range checking.

Definition at line 239 of file GModelSpatial.cpp.

References G_AT, m_pars, and size().

void GModelSpatial::autoscale ( void )

Autoscale parameters.

Sets the scale factors for all parameters so that the values are unity.

Definition at line 306 of file GModelSpatial.cpp.

References m_pars.

Referenced by GModelSpatialDiffuseConst::GModelSpatialDiffuseConst(), and GModelSpatialDiffuseCube::GModelSpatialDiffuseCube().

virtual std::string GModelSpatial::classname ( void ) const

pure virtual

Return class name.

Returns: String containing the class name.

Returns the class name for non-abstract classes in a human readable way.

Implements GBase.

Implemented in GModelSpatialRadialShell, GModelSpatialDiffuseCube, GModelSpatialPointSource, GModelSpatialEllipticalGeneralGauss, GModelSpatialEllipticalGauss, GModelSpatialEllipticalDisk, GModelSpatialRadialDisk, GModelSpatialRadialGeneralGauss, GModelSpatialRadialRing, GModelSpatialDiffuseMap, GModelSpatialRadialGauss, GModelSpatialElliptical, GModelSpatialRadial, GModelSpatialDiffuse, GModelSpatialDiffuseConst, GModelSpatialRadialProfile, GModelSpatialRadialProfileDMBurkert, GModelSpatialRadialProfileDMEinasto, GModelSpatialRadialProfileDMZhao, GModelSpatialComposite, and GModelSpatialRadialProfileGauss.

Referenced by GModelSky::eflux(), and GModelSky::flux().

virtual void GModelSpatial::clear ( void )

pure virtual

Clear object.

Sets the object to a clean initial state. After calling the method the object will be in the same state as it were if an empty instance of the object would have been created.

Implements GBase.

Implemented in GModelSpatialRadialShell, GModelSpatialDiffuseCube, GModelSpatialPointSource, GModelSpatialEllipticalGeneralGauss, GModelSpatialEllipticalGauss, GModelSpatialEllipticalDisk, GModelSpatialRadialDisk, GModelSpatialRadialGeneralGauss, GModelSpatialRadialRing, GModelSpatialDiffuseMap, GModelSpatialRadialGauss, GModelSpatialElliptical, GModelSpatialRadial, GModelSpatialDiffuse, GModelSpatialDiffuseConst, GModelSpatialRadialProfile, GModelSpatialRadialProfileDMBurkert, GModelSpatialRadialProfileDMEinasto, GModelSpatialRadialProfileDMZhao, GModelSpatialComposite, and GModelSpatialRadialProfileGauss.

virtual GModelSpatial* GModelSpatial::clone ( void ) const

pure virtual

Clones object.

Returns: Pointer to deep copy of object.

Creates a deep copy of the object and returns a pointer to the object.

Implements GBase.

Implemented in GModelSpatialRadialShell, GModelSpatialDiffuseCube, GModelSpatialPointSource, GModelSpatialEllipticalGeneralGauss, GModelSpatialEllipticalGauss, GModelSpatialEllipticalDisk, GModelSpatialRadialDisk, GModelSpatialRadialGeneralGauss, GModelSpatialRadialRing, GModelSpatialDiffuseMap, GModelSpatialRadialGauss, GModelSpatialElliptical, GModelSpatialRadial, GModelSpatialDiffuse, GModelSpatialDiffuseConst, GModelSpatialRadialProfile, GModelSpatialRadialProfileDMBurkert, GModelSpatialRadialProfileDMEinasto, GModelSpatialRadialProfileDMZhao, GModelSpatialComposite, and GModelSpatialRadialProfileGauss.

Referenced by GModelSpatialComposite::append(), GModelSky::copy_members(), GModelSky::GModelSky(), GModelSky::spatial(), and GModelSpatialComposite::write().

virtual GClassCode GModelSpatial::code ( void ) const

pure virtual

Implemented in GModelSpatialElliptical, GModelSpatialRadial, GModelSpatialDiffuse, GModelSpatialPointSource, and GModelSpatialComposite.

Referenced by GCTAResponseCube::irf_spatial(), GResponse::irf_spatial(), and GCTAResponseIrf::nroi().

virtual bool GModelSpatial::contains	(	const GSkyDir &	dir,
		const double &	margin = `0.0`
	)		const

pure virtual

Implemented in GModelSpatialRadialShell, GModelSpatialDiffuseCube, GModelSpatialPointSource, GModelSpatialEllipticalGeneralGauss, GModelSpatialEllipticalGauss, GModelSpatialEllipticalDisk, GModelSpatialRadialDisk, GModelSpatialRadialGeneralGauss, GModelSpatialRadialRing, GModelSpatialDiffuseMap, GModelSpatialRadialGauss, GModelSpatialElliptical, GModelSpatialRadial, GModelSpatialRadialProfile, GModelSpatialDiffuse, GModelSpatialDiffuseConst, and GModelSpatialComposite.

void GModelSpatial::copy_members ( const GModelSpatial & model )

protected

Copy class members.

Parameters

[in] model Spatial model.

Definition at line 408 of file GModelSpatial.cpp.

References m_pars, m_region, and m_type.

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

virtual double GModelSpatial::eval	(	const GPhoton &	photon,
		const bool &	gradients = `false`
	)		const

pure virtual

Implemented in GModelSpatialRadial, GModelSpatialElliptical, GModelSpatialDiffuseCube, GModelSpatialPointSource, GModelSpatialDiffuseMap, GModelSpatialDiffuse, GModelSpatialDiffuseConst, and GModelSpatialComposite.

Referenced by com_elliptical_kerns_omega::eval(), cta_irf_diffuse_kern_phi::eval(), cta_nroi_diffuse_kern_phi::eval(), cta_psf_diffuse_kern_phi::eval(), GModelSky::gradients(), GCOMResponse::irf_diffuse(), and GModelSky::value().

double GModelSpatial::flux	(	const GSkyRegion &	region,
		const GEnergy &	srcEng = `GEnergy()`,
		const GTime &	srcTime = `GTime()`
	)		const

virtual

Returns model flux within sky region.

Parameters

[in]	region	Sky region.
[in]	srcEng	Energy.
[in]	srcTime	Time.

Returns: Flux (adimensional or ph/cm2/s).

Computes

\[ \int_{\rho_{\rm min}}^{\rho_{\rm max}} \sin \rho \times \int_{\omega} M(\rho, \omega | E, t) d\omega d\rho \]

where \(M(\rho, \omega | E, t)\) is the spatial model, \(\rho\) is the distance from the model centre, and \(\omega\) is the azimuth angle around the model centre.

The integration is performed over the circular region that bounds the spatial model.

Reimplemented in GModelSpatialDiffuseCube, GModelSpatialPointSource, GModelSpatialDiffuseMap, GModelSpatialDiffuseConst, and GModelSpatialComposite.

Definition at line 343 of file GModelSpatial.cpp.

References GSkyRegionCircle::centre(), gammalib::centre(), gammalib::deg2rad, m_region, GSkyRegionCircle::overlaps(), GSkyRegionCircle::radius(), GIntegral::romberg(), set_region(), and GIntegral::silent().

Referenced by GModelSky::eflux(), GModelSpatial::circle_int_kern_rho::eval(), GModelSpatial::circle_int_kern_omega::eval(), GModelSky::flux_kern::eval(), and GModelSky::flux().

void GModelSpatial::free_members ( void )

protected

bool GModelSpatial::has_free_pars ( void ) const

Checks if the spatial model has free parameters.

Returns: True if spatial model has free parameters.

Definition at line 283 of file GModelSpatial.cpp.

References m_pars, and size().

Referenced by GCTAResponseCube::irf_spatial(), GResponse::irf_spatial(), and GCTAResponseIrf::nroi().

bool GModelSpatial::has_par ( const std::string & name ) const

Checks if parameter name exists.

Parameters

[in] name Parameter name.

Returns: True if parameter with specified name exists.

Searches all parameter names for a match with the specified name. If the specified name has been found, true is returned.

Definition at line 260 of file GModelSpatial.cpp.

References m_pars, and size().

void GModelSpatial::init_members ( void )

protected

Initialise class members.

Definition at line 391 of file GModelSpatial.cpp.

References GSkyRegionCircle::clear(), m_pars, m_region, and m_type.

virtual GSkyDir GModelSpatial::mc	(	const GEnergy &	energy,
		const GTime &	time,
		GRan &	ran
	)		const

pure virtual

Implemented in GModelSpatialRadialShell, GModelSpatialDiffuseCube, GModelSpatialEllipticalGeneralGauss, GModelSpatialPointSource, GModelSpatialEllipticalGauss, GModelSpatialEllipticalDisk, GModelSpatialRadialDisk, GModelSpatialRadialGeneralGauss, GModelSpatialRadialRing, GModelSpatialRadialGauss, GModelSpatialElliptical, GModelSpatialDiffuseMap, GModelSpatialRadial, GModelSpatialRadialProfile, GModelSpatialDiffuse, GModelSpatialDiffuseConst, and GModelSpatialComposite.

Referenced by GModelSky::mc().

virtual double GModelSpatial::mc_norm	(	const GSkyDir &	dir,
		const double &	radius
	)		const

pure virtual

Implemented in GModelSpatialRadial, GModelSpatialElliptical, GModelSpatialDiffuseCube, GModelSpatialPointSource, GModelSpatialDiffuseMap, GModelSpatialDiffuse, GModelSpatialDiffuseConst, and GModelSpatialComposite.

Referenced by GModelSky::mc().

GModelSpatial & GModelSpatial::operator= ( const GModelSpatial & model )

virtual

Assignment operator.

Parameters

[in] model Spatial model.

Returns: Spatial model.

Definition at line 112 of file GModelSpatial.cpp.

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

Referenced by GModelSpatialComposite::operator=(), GModelSpatialDiffuse::operator=(), GModelSpatialRadial::operator=(), GModelSpatialElliptical::operator=(), and GModelSpatialPointSource::operator=().

GModelPar & GModelSpatial::operator[] ( const int & index )

inlinevirtual

Returns model parameter.

Parameters

[in] index Parameter index [0,...,size()-1].

Returns: Model parameter.

Returns model parameter without index range checking.

Definition at line 222 of file GModelSpatial.hpp.

References m_pars.

const GModelPar & GModelSpatial::operator[] ( const int & index ) const

inlinevirtual

Returns model parameter (const version)

Parameters

[in] index Parameter index [0,...,size()-1].

Returns: Model parameter.

Returns model parameter without index range checking.

Definition at line 237 of file GModelSpatial.hpp.

References m_pars.

GModelPar & GModelSpatial::operator[] ( const std::string & name )

virtual

Returns model parameter.

Parameters

[in] name Parameter name.

Returns: Model parameter reference.

Exceptions

GException::invalid_argument Parameter with specified name not found.

Returns reference to the model parameter of specified name.

Definition at line 144 of file GModelSpatial.cpp.

References G_ACCESS, m_pars, and size().

const GModelPar & GModelSpatial::operator[] ( const std::string & name ) const

virtual

Returns model parameter (const version)

Parameters

[in] name Parameter name.

Returns: Model parameter reference.

Exceptions

GException::invalid_argument Parameter with specified name not found.

Returns reference to the model parameter of specified name.

Definition at line 177 of file GModelSpatial.cpp.

References G_ACCESS, m_pars, and size().

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

pure virtual

Print content of object.

Parameters

[in] chatter Chattiness (defaults to NORMAL).

Returns: String containing the content of the object.

Formats the content in a standard way and puts this content in a C++ string that is returned.

Implements GBase.

Implemented in GModelSpatialRadialShell, GModelSpatialDiffuseCube, GModelSpatialPointSource, GModelSpatialEllipticalGeneralGauss, GModelSpatialEllipticalGauss, GModelSpatialEllipticalDisk, GModelSpatialRadialRing, GModelSpatialRadialDisk, GModelSpatialRadialGeneralGauss, GModelSpatialRadialGauss, GModelSpatialDiffuseMap, GModelSpatialElliptical, GModelSpatialRadial, GModelSpatialDiffuse, GModelSpatialDiffuseConst, GModelSpatialComposite, GModelSpatialRadialProfileDMBurkert, GModelSpatialRadialProfileDMEinasto, GModelSpatialRadialProfileDMZhao, GModelSpatialRadialProfileGauss, and GModelSpatialRadialProfile.

const GSkyRegion * GModelSpatial::region ( void ) const

inline

Return boundary sky region.

Returns: Boundary sky region.

Returns a sky region that fully encloses the spatial model component.

Definition at line 265 of file GModelSpatial.hpp.

References m_region, and set_region().

virtual void GModelSpatial::set_region ( void ) const

protectedpure virtual

Implemented in GModelSpatialDiffuseCube, GModelSpatialRadialShell, GModelSpatialElliptical, GModelSpatialPointSource, GModelSpatialDiffuseMap, GModelSpatialRadial, GModelSpatialEllipticalGeneralGauss, GModelSpatialRadialRing, GModelSpatialRadialGeneralGauss, GModelSpatialComposite, GModelSpatialEllipticalGauss, GModelSpatialRadialDisk, GModelSpatialEllipticalDisk, GModelSpatialRadialGauss, GModelSpatialDiffuseConst, GModelSpatialRadialProfile, and GModelSpatialDiffuse.

Referenced by flux(), and region().

int GModelSpatial::size ( void ) const

inline

Return number of parameters.

Returns: Number of parameters in spatial model component.

Returns the number of parameters in the spatial model component.

Definition at line 251 of file GModelSpatial.hpp.

References m_pars.

std::string GModelSpatial::type ( void ) const

inline

Return model type.

Returns: Model type.

Returns the type of the spatial model.

Definition at line 192 of file GModelSpatial.hpp.

References m_type.

void GModelSpatial::type ( const std::string & type )

inline

Set model type.

Parameters

[in] type Model type.

Set the type of the spatial model.

Definition at line 206 of file GModelSpatial.hpp.

References m_type, and type().

virtual void GModelSpatial::write ( GXmlElement & xml ) const

pure virtual

Member Data Documentation

std::vector<GModelPar*> GModelSpatial::m_pars

protected

Parameter pointers.

Definition at line 180 of file GModelSpatial.hpp.

GSkyRegionCircle GModelSpatial::m_region

protected

Bounding circle.

Definition at line 179 of file GModelSpatial.hpp.

std::string GModelSpatial::m_type

protected

Spatial model type.

Definition at line 178 of file GModelSpatial.hpp.

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

include/GModelSpatial.hpp
src/model/GModelSpatial.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation