#include <GModelSpatialRadialProfileDMZhao.hpp>

Inheritance diagram for GModelSpatialRadialProfileDMZhao:

Classes
class	halo_kernel_los

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

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

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

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

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

virtual void	clear (void)
	Clear radial DMZhao profile model. More...

virtual GModelSpatialRadialProfileDMZhao *	clone (void) const
	Clone radial DMZhao profile model. More...

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

virtual double	theta_min (void) const
	Return minimum model radius (in radians) More...

virtual double	theta_max (void) const
	Return maximum model radius (in radians) More...

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

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

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

double	scale_radius (void) const
	Return scale radius. More...

void	scale_radius (const double &scale_radius)
	Set scale radius. More...

double	scale_density (void) const
	Return scale density. More...

void	scale_density (const double &scale_density)
	Set scale density. More...

double	halo_distance (void) const
	Return halo distance. More...

void	halo_distance (const double &halo_distance)
	Set halo distance. More...

double	alpha (void) const
	Return Zhao alpha power index. More...

void	alpha (const double &alpha)
	Set Zhao alpha power index. More...

double	beta (void) const
	Return Zhao beta power index. More...

void	beta (const double &beta)
	Set Zhao beta power index. More...

double	gamma (void) const
	Return Zhao gamma power index. More...

void	gamma (const double &gamma)
	Set Zhao gamma power index. More...

double	mass_density (const double &radius) const
	Calculate Halo Mass Density. More...

double	jfactor (const double &angle) const
	Calculate J-factor. More...

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

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

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

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

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

virtual double	eval (const double &theta, const GEnergy &energy, const GTime &time, const bool &gradients=false) const
	Evaluate function (in units of sr^-1) More...

virtual GSkyDir	mc (const GEnergy &energy, const GTime &time, GRan &ran) const
	Return MC sky direction. More...

virtual bool	contains (const GSkyDir &dir, const double &margin=0.0) const
	Checks where model contains specified sky direction. More...

int	num_nodes (void) const
	Return number of nodes. More...

void	num_nodes (const int &number)
	Set number of nodes. More...

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

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

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

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

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

virtual GClassCode	code (void) const
	Return class code. More...

virtual bool	is_energy_dependent (void) const
	Signals whether radial model is energy dependent. More...

virtual bool	is_time_dependent (void) const
	Signals whether radial model is time dependent. More...

virtual double	eval (const GPhoton &photon, const bool &gradients=false) const
	Return model value. More...

virtual double	mc_norm (const GSkyDir &dir, const double &radius) const
	Return normalization of radial source for Monte Carlo simulations. More...

std::string	coordsys (void) const
	Return coordinate system. More...

const GSkyDir &	dir (void) const
	Return position of radial spatial model. More...

void	dir (const GSkyDir &dir)
	Set position of radial spatial model. More...

Public Member Functions inherited from GModelSpatial
	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 double	flux (const GSkyRegion &region, const GEnergy &srcEng=GEnergy(), const GTime &srcTime=GTime()) const
	Returns model flux integrated in circular 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 GModelSpatialRadialProfileDMZhao &model)
	Copy class members. More...

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

void	update (void) const
	Update precomputation cache. More...

virtual double	profile_value (const double &theta) const
	Radial profile. More...

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

void	copy_members (const GModelSpatialRadialProfile &model)
	Copy class members. More...

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

int	cache_index (void) const
	Return index to pre-computation cache. More...

virtual void	set_region (void) const
	Set boundary sky region. More...

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

void	copy_members (const GModelSpatialRadial &model)
	Copy class members. More...

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

bool	is_celestial (void) const
	Check if model holds celestial coordinates. More...

Protected Member Functions inherited from GModelSpatial
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...

Protected Attributes
GModelPar	m_theta_min
	Minimum theta angle. More...

GModelPar	m_theta_max
	Maximum theta angle. More...

GModelPar	m_scale_radius
	Scale radius of halo profile. More...

GModelPar	m_scale_density
	Scale density of halo profile. More...

GModelPar	m_halo_distance
	Distance from earth to halo center. More...

GModelPar	m_alpha
	Power index, inverse transition region width. More...

GModelPar	m_beta
	Power index, slope at >> m_scale_radius. More...

GModelPar	m_gamma
	Power index, slope at << m_scale_radius. More...

GModelPar	m_core_radius
	Core radius. More...

double	m_last_scale_radius

double	m_last_scale_density

double	m_mass_radius

double	m_scale_density_squared

Protected Attributes inherited from GModelSpatialRadialProfile
bool	m_coord_indep
	True if model independent of sky coordinates. More...

int	m_num_nodes
	Number of profile nodes. More...

std::vector< profile >	m_profile
	Pre-computation cache. More...

Protected Attributes inherited from GModelSpatialRadial
GModelPar	m_lon
	Right Ascension or Galactic longitude (deg) More...

GModelPar	m_lat
	Declination or Galactic latitude (deg) More...

GSkyDir	m_dir
	Sky direction representing parameters. More...

double	m_last_lon
	Last longitude. More...

double	m_last_lat
	Last latitude. More...

Protected Attributes inherited from GModelSpatial
std::string	m_type
	Spatial model type. More...

GSkyRegionCircle	m_region
	Bounding circle. More...

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

Detailed Description

Definition at line 49 of file GModelSpatialRadialProfileDMZhao.hpp.

Constructor & Destructor Documentation

GModelSpatialRadialProfileDMZhao::GModelSpatialRadialProfileDMZhao ( void )

Void constructor.

Constructs empty radial DMZhao profile

Definition at line 66 of file GModelSpatialRadialProfileDMZhao.cpp.

References init_members().

Referenced by clone().

GModelSpatialRadialProfileDMZhao::GModelSpatialRadialProfileDMZhao ( const GXmlElement & xml )

explicit

XML constructor.

Parameters

[in] xml XML element.

Constructs radial DMZhao profile model by extracting information from an XML element. See the read() method for more information about the expected structure of the XML element.

Definition at line 86 of file GModelSpatialRadialProfileDMZhao.cpp.

References init_members(), and read().

GModelSpatialRadialProfileDMZhao::GModelSpatialRadialProfileDMZhao ( const GModelSpatialRadialProfileDMZhao & model )

Copy constructor.

Parameters

[in] model Radial DMZhao profile model.

Copies radial DMZhao profile model from another radial profile model.

Definition at line 107 of file GModelSpatialRadialProfileDMZhao.cpp.

References copy_members(), and init_members().

GModelSpatialRadialProfileDMZhao::~GModelSpatialRadialProfileDMZhao ( void )

virtual

Destructor.

Destructs radial DMZhao profile model.

Definition at line 126 of file GModelSpatialRadialProfileDMZhao.cpp.

References free_members().

Member Function Documentation

double GModelSpatialRadialProfileDMZhao::alpha ( void ) const

inline

Return Zhao alpha power index.

Returns: alpha (unitless).

Returns the alpha power index in the Zhao halo density function

Definition at line 251 of file GModelSpatialRadialProfileDMZhao.hpp.

References m_alpha, and GOptimizerPar::value().

void GModelSpatialRadialProfileDMZhao::alpha ( const double & alpha )

inline

Set Zhao alpha power index.

Parameters

[in] alpha (unitless).

Sets the Zhao profile alpha power index.

Definition at line 265 of file GModelSpatialRadialProfileDMZhao.hpp.

References m_alpha, and GOptimizerPar::value().

double GModelSpatialRadialProfileDMZhao::beta ( void ) const

inline

Return Zhao beta power index.

Returns: beta (unitless).

Returns the beta power index in the Zhao halo density function

Definition at line 280 of file GModelSpatialRadialProfileDMZhao.hpp.

References m_beta, and GOptimizerPar::value().

void GModelSpatialRadialProfileDMZhao::beta ( const double & beta )

inline

Set Zhao beta power index.

Parameters

[in] beta (unitless).

Sets the Zhao profile beta power index.

Definition at line 294 of file GModelSpatialRadialProfileDMZhao.hpp.

References m_beta, and GOptimizerPar::value().

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

inlinevirtual

Return class name.

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

Implements GModelSpatialRadialProfile.

Definition at line 148 of file GModelSpatialRadialProfileDMZhao.hpp.

void GModelSpatialRadialProfileDMZhao::clear ( void )

virtual

Clear radial DMZhao profile model.

Clears radial DMZhao profile model.

Implements GModelSpatialRadialProfile.

Definition at line 185 of file GModelSpatialRadialProfileDMZhao.cpp.

References GModelSpatialRadialProfile::free_members(), free_members(), GModelSpatialRadial::free_members(), GModelSpatial::free_members(), GModelSpatialRadialProfile::init_members(), init_members(), GModelSpatialRadial::init_members(), and GModelSpatial::init_members().

GModelSpatialRadialProfileDMZhao * GModelSpatialRadialProfileDMZhao::clone ( void ) const

virtual

Clone radial DMZhao profile model.

Returns: Pointer to deep copy of radial DMZhao profile model.

Returns a deep copy of the radial DMZhao profile model.

Implements GModelSpatialRadialProfile.

Definition at line 211 of file GModelSpatialRadialProfileDMZhao.cpp.

References GModelSpatialRadialProfileDMZhao().

void GModelSpatialRadialProfileDMZhao::copy_members ( const GModelSpatialRadialProfileDMZhao & model )

protected

Copy class members.

Parameters

[in] model Radial DMZhao model.

Copies class members from another radial profile model.

Definition at line 588 of file GModelSpatialRadialProfileDMZhao.cpp.

References m_alpha, m_beta, m_core_radius, m_gamma, m_halo_distance, m_last_scale_density, m_last_scale_radius, m_mass_radius, m_scale_density, m_scale_density_squared, m_scale_radius, m_theta_max, m_theta_min, and GModelSpatial::m_type.

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

void GModelSpatialRadialProfileDMZhao::free_members ( void )

protected

Delete class members.

Definition at line 618 of file GModelSpatialRadialProfileDMZhao.cpp.

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

double GModelSpatialRadialProfileDMZhao::gamma ( void ) const

inline

Return Zhao gamma power index.

Returns: gamma (unitless).

Returns the gamma power index in the Zhao halo density function

Definition at line 309 of file GModelSpatialRadialProfileDMZhao.hpp.

References m_gamma, and GOptimizerPar::value().

void GModelSpatialRadialProfileDMZhao::gamma ( const double & gamma )

inline

Set Zhao gamma power index.

Parameters

[in] gamma (unitless).

Sets the Zhao profile gamma power index.

Definition at line 323 of file GModelSpatialRadialProfileDMZhao.hpp.

References m_gamma, and GOptimizerPar::value().

double GModelSpatialRadialProfileDMZhao::halo_distance ( void ) const

inline

Return halo distance.

Returns: Halo distance (kpc).

Returns the distance to the halo center in kpc.

Definition at line 222 of file GModelSpatialRadialProfileDMZhao.hpp.

References m_halo_distance, and GOptimizerPar::value().

void GModelSpatialRadialProfileDMZhao::halo_distance ( const double & distance )

inline

Set halo distance.

Parameters

[in] distance Halo distance (kpc).

Sets the distance between the observer and the halo center in kpc.

Definition at line 236 of file GModelSpatialRadialProfileDMZhao.hpp.

References m_halo_distance, and GOptimizerPar::value().

void GModelSpatialRadialProfileDMZhao::init_members ( void )

protected

Initialise class members.

Definition at line 452 of file GModelSpatialRadialProfileDMZhao.cpp.

References GOptimizerPar::clear(), GOptimizerPar::fix(), GOptimizerPar::free(), GOptimizerPar::gradient(), GOptimizerPar::has_grad(), m_alpha, m_beta, m_core_radius, m_gamma, m_halo_distance, m_last_scale_density, m_last_scale_radius, m_mass_radius, GModelSpatial::m_pars, m_scale_density, m_scale_density_squared, m_scale_radius, m_theta_max, m_theta_min, GModelSpatial::m_type, GOptimizerPar::max(), GOptimizerPar::min(), GOptimizerPar::name(), GOptimizerPar::scale(), GOptimizerPar::unit(), and GOptimizerPar::value().

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

double GModelSpatialRadialProfileDMZhao::jfactor ( const double & angle ) const

Calculate J-factor.

Parameters

[in] angle from halo center (radians)

Returns: J-factor

Calculates the halo's J-factor at an angle from the halo center.

Definition at line 805 of file GModelSpatialRadialProfileDMZhao.cpp.

References profile_value(), and gammalib::twopi.

double GModelSpatialRadialProfileDMZhao::mass_density ( const double & radius ) const

Calculate Halo Mass Density.

Parameters

[in] radius Distance from halo center (kpc).

Returns: Halo mass density.

Calculates the halo's mass density at a given radial distance from the halo center.

Definition at line 775 of file GModelSpatialRadialProfileDMZhao.cpp.

References m_alpha, m_beta, m_core_radius, m_gamma, m_halo_distance, m_scale_density, m_scale_radius, sqrt(), and GOptimizerPar::value().

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

virtual

Assignment operator.

Parameters

[in] model Radial DMZhao profile model.

Returns: Radial DMZhao profile model.

Assigns radial DMZhao profile model.

Definition at line 150 of file GModelSpatialRadialProfileDMZhao.cpp.

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

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

virtual

Print information.

Parameters

[in] chatter Chattiness.

Returns: String containing model information.

Implements GModelSpatialRadialProfile.

Definition at line 418 of file GModelSpatialRadialProfileDMZhao.cpp.

References GModelSpatial::m_pars, gammalib::parformat(), SILENT, GModelSpatial::size(), and gammalib::str().

double GModelSpatialRadialProfileDMZhao::profile_value ( const double & theta ) const

protectedvirtual

Radial profile.

Parameters

[in] theta Angular distance from DMZhao centre (radians).

Returns: Profile value.

Implements GModelSpatialRadialProfile.

Definition at line 631 of file GModelSpatialRadialProfileDMZhao.cpp.

References m_alpha, m_beta, m_core_radius, m_gamma, m_halo_distance, m_mass_radius, m_scale_density_squared, m_scale_radius, update(), and GOptimizerPar::value().

Referenced by jfactor().

void GModelSpatialRadialProfileDMZhao::read ( const GXmlElement & xml )

virtual

Read model from XML element.

Parameters

[in] xml XML element.

Reads the DMZhao radial profile model information from an XML element. The XML element shall have the format

<spatialModel type="DMZhaoProfile">
  <parameter name="RA"           scale=.. value=.. min=.. max=.. free=../>
  <parameter name="DEC"          scale=.. value=.. min=.. max=.. free=../>
  <parameter name="ScaleRadius"  scale=.. value=.. min=.. max=.. free=../>
  <parameter name="ScaleDensity" scale=.. value=.. min=.. max=.. free=../>
  <parameter name="HaloDistance" scale=.. value=.. min=.. max=.. free=../>
  <parameter name="Alpha"        scale=.. value=.. min=.. max=.. free=../>
  <parameter name="Beta"         scale=.. value=.. min=.. max=.. free=../>
  <parameter name="Gamma"        scale=.. value=.. min=.. max=.. free=../>
  <parameter name="ThetaMin"     scale=.. value=.. min=.. max=.. free=../>
  <parameter name="ThetaMax"     scale=.. value=.. min=.. max=.. free=../>
  <parameter name="CoreRadius"   scale=.. value=.. min=.. max=.. free=../>
</spatialModel>

Reimplemented from GModelSpatialRadial.

Definition at line 292 of file GModelSpatialRadialProfileDMZhao.cpp.

References G_READ, m_alpha, m_beta, m_core_radius, m_gamma, m_halo_distance, m_scale_density, m_scale_radius, m_theta_max, m_theta_min, GModelSpatialRadial::read(), GModelPar::read(), gammalib::xml_check_parnum(), and gammalib::xml_get_par().

Referenced by GModelSpatialRadialProfileDMZhao().

double GModelSpatialRadialProfileDMZhao::scale_density ( void ) const

inline

Return scale density.

Returns: Scale density (GeV/cm^3).

Returns the scale density (mass/volume density at the scale radius) of the halo profile in GeV/cm^3.

Definition at line 192 of file GModelSpatialRadialProfileDMZhao.hpp.

References m_scale_density, and GOptimizerPar::value().

Referenced by update().

void GModelSpatialRadialProfileDMZhao::scale_density ( const double & density )

inline

Set scale density.

Parameters

[in] density Scale density (GeV/cm^3).

Sets the scale density (mass/volume density at the scale radius) of the halo profile in GeV/cm^3.

Definition at line 207 of file GModelSpatialRadialProfileDMZhao.hpp.

References m_scale_density, and GOptimizerPar::value().

double GModelSpatialRadialProfileDMZhao::scale_radius ( void ) const

inline

Return scale radius.

Returns: Scale radius (kpc).

Returns the scale radius of the halo profile in kpc.

Definition at line 162 of file GModelSpatialRadialProfileDMZhao.hpp.

References m_scale_radius, and GOptimizerPar::value().

Referenced by update().

void GModelSpatialRadialProfileDMZhao::scale_radius ( const double & radius )

inline

Set scale radius.

Parameters

[in] radius Scale radius (kpc).

Sets the scale radius of the halo profile in kpc.

Definition at line 176 of file GModelSpatialRadialProfileDMZhao.hpp.

References m_scale_radius, and GOptimizerPar::value().

double GModelSpatialRadialProfileDMZhao::theta_max ( void ) const

virtual

Return maximum model radius (in radians)

Returns: Maximum model radius (in radians).

Implements GModelSpatialRadialProfile.

Definition at line 238 of file GModelSpatialRadialProfileDMZhao.cpp.

References atan(), gammalib::deg2rad, m_halo_distance, m_mass_radius, m_theta_max, gammalib::pi, update(), and GOptimizerPar::value().

double GModelSpatialRadialProfileDMZhao::theta_min ( void ) const

virtual

Return minimum model radius (in radians)

Returns: Minimum model radius (in radians).

Implements GModelSpatialRadialProfile.

Definition at line 222 of file GModelSpatialRadialProfileDMZhao.cpp.

References m_theta_min, update(), and GOptimizerPar::value().

void GModelSpatialRadialProfileDMZhao::update ( void ) const

protected

Update precomputation cache.

Computes the m_mass_radius calculation, determining the radius around the halo that contains 99.99% of the mass. For a Zhao halo profile, this is just 10.0 * scale_radius .

Definition at line 745 of file GModelSpatialRadialProfileDMZhao.cpp.

References m_last_scale_density, m_last_scale_radius, m_mass_radius, m_scale_density_squared, scale_density(), and scale_radius().

Referenced by profile_value(), theta_max(), and theta_min().

void GModelSpatialRadialProfileDMZhao::write ( GXmlElement & xml ) const

virtual

Write model into XML element.

Parameters

[in] xml XML element into which model information is written.

Writes the DMZhao radial profile model information into an XML element. The XML element will have the format

<spatialModel type="DMZhaoProfile">
  <parameter name="RA"           scale=.. value=.. min=.. max=.. free=../>
  <parameter name="DEC"          scale=.. value=.. min=.. max=.. free=../>
  <parameter name="ScaleRadius"  scale=.. value=.. min=.. max=.. free=../>
  <parameter name="ScaleDensity" scale=.. value=.. min=.. max=.. free=../>
  <parameter name="HaloDistance" scale=.. value=.. min=.. max=.. free=../>
  <parameter name="Alpha"        scale=.. value=.. min=.. max=.. free=../>
  <parameter name="Beta"         scale=.. value=.. min=.. max=.. free=../>
  <parameter name="Gamma"        scale=.. value=.. min=.. max=.. free=../>
  <parameter name="ThetaMin"     scale=.. value=.. min=.. max=.. free=../>
  <parameter name="ThetaMax"     scale=.. value=.. min=.. max=.. free=../>
  <parameter name="CoreRadius"   scale=.. value=.. min=.. max=.. free=../>
</spatialModel>

Reimplemented from GModelSpatialRadial.

Definition at line 363 of file GModelSpatialRadialProfileDMZhao.cpp.

References G_WRITE, m_alpha, m_beta, m_core_radius, m_gamma, m_halo_distance, m_scale_density, m_scale_radius, m_theta_max, m_theta_min, GModelSpatial::type(), GModelSpatialRadial::write(), GModelPar::write(), gammalib::xml_check_type(), and gammalib::xml_need_par().