GammaLib  1.7.0.dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GModelSpatialRadialProfileGauss Class Reference

#include <GModelSpatialRadialProfileGauss.hpp>

Inheritance diagram for GModelSpatialRadialProfileGauss:
GModelSpatialRadialProfile GModelSpatialRadial GModelSpatial GBase

Public Member Functions

 GModelSpatialRadialProfileGauss (void)
 Void constructor. More...
 
 GModelSpatialRadialProfileGauss (const GXmlElement &xml)
 XML constructor. More...
 
 GModelSpatialRadialProfileGauss (const GSkyDir &dir, const double &sigma)
 Constructor. More...
 
 GModelSpatialRadialProfileGauss (const GModelSpatialRadialProfileGauss &model)
 Copy constructor. More...
 
virtual ~GModelSpatialRadialProfileGauss (void)
 Destructor. More...
 
virtual
GModelSpatialRadialProfileGauss
operator= (const GModelSpatialRadialProfileGauss &model)
 Assignment operator. More...
 
virtual void clear (void)
 Clear radial Gaussian profile model. More...
 
virtual
GModelSpatialRadialProfileGauss
clone (void) const
 Clone radial Gaussian profile model. More...
 
virtual std::string classname (void) const
 Return class name. More...
 
virtual std::string type (void) const
 Return model type. More...
 
virtual double theta_min (void) const
 Return maximum 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 sigma (void) const
 Return Gaussian sigma. More...
 
void sigma (const double &sigma)
 Set Gaussian sigma. 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...
 
virtual GSkyRegionregion (void) const
 Return boundary sky region. 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 GModelSpatialRadialoperator= (const GModelSpatialRadial &model)
 Assignment operator. More...
 
virtual GClassCode code (void) const
 Return class code. 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...
 
double ra (void) const
 Return Right Ascencion of model centre. More...
 
double dec (void) const
 Return Declination of model centre. More...
 
void ra (const double &ra)
 Set Right Ascencion of model centre. More...
 
void dec (const double &dec)
 Set Declination of model centre. More...
 
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 GModelSpatialoperator= (const GModelSpatial &model)
 Assignment operator. More...
 
virtual GModelParoperator[] (const int &index)
 Returns model parameter. More...
 
virtual const GModelParoperator[] (const int &index) const
 Returns model parameter (const version) More...
 
virtual GModelParoperator[] (const std::string &name)
 Returns model parameter. More...
 
virtual const GModelParoperator[] (const std::string &name) const
 Returns model parameter (const version) More...
 
GModelParat (const int &index)
 Returns model parameter. More...
 
const GModelParat (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...
 
double flux (const GSkyRegion *reg, const GEnergy &srcEng=GEnergy(), const GTime &srcTime=GTime()) const
 Returns model flux integrated in circular 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 GModelSpatialRadialProfileGauss &model)
 Copy class members. More...
 
void free_members (void)
 Delete class members. 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...
 
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...
 
- 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_sigma
 Gaussian width (deg) More...
 
- Protected Attributes inherited from GModelSpatialRadialProfile
bool m_coord_indep
 
int m_num_nodes
 Number of profile nodes. More...
 
GSkyRegionCircle m_region
 Bounding circle. More...
 
std::vector< profilem_profile
 Pre-computation cache. More...
 
- Protected Attributes inherited from GModelSpatialRadial
GModelPar m_ra
 Right Ascension (deg) More...
 
GModelPar m_dec
 Declination (deg) More...
 
- Protected Attributes inherited from GModelSpatial
std::vector< GModelPar * > m_pars
 Parameter pointers. More...
 

Detailed Description

Definition at line 47 of file GModelSpatialRadialProfileGauss.hpp.

Constructor & Destructor Documentation

GModelSpatialRadialProfileGauss::GModelSpatialRadialProfileGauss ( void  )

Void constructor.

Constructs empty radial Gaussian profile

Definition at line 66 of file GModelSpatialRadialProfileGauss.cpp.

References init_members().

Referenced by clone().

GModelSpatialRadialProfileGauss::GModelSpatialRadialProfileGauss ( const GXmlElement xml)
explicit

XML constructor.

Parameters
[in]xmlXML element.

Constructs radial Gaussian 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 GModelSpatialRadialProfileGauss.cpp.

References init_members(), and read().

GModelSpatialRadialProfileGauss::GModelSpatialRadialProfileGauss ( const GSkyDir dir,
const double &  sigma 
)

Constructor.

Parameters
[in]dirSky position of Gaussian.
[in]sigmaWidth of Gaussian (in degrees).

Constructs a Gaussian spatial model using a sky direction (dir) and a Gaussian width parameter sigma in degrees.

Definition at line 109 of file GModelSpatialRadialProfileGauss.cpp.

References GModelSpatialRadial::dir(), init_members(), and sigma().

GModelSpatialRadialProfileGauss::GModelSpatialRadialProfileGauss ( const GModelSpatialRadialProfileGauss model)

Copy constructor.

Parameters
[in]modelRadial Gaussian profile model.

Copies radial Gaussian profile model from another radial profile model.

Definition at line 132 of file GModelSpatialRadialProfileGauss.cpp.

References copy_members(), and init_members().

GModelSpatialRadialProfileGauss::~GModelSpatialRadialProfileGauss ( void  )
virtual

Destructor.

Destructs radial Gaussian profile model.

Definition at line 151 of file GModelSpatialRadialProfileGauss.cpp.

References free_members().

Member Function Documentation

std::string GModelSpatialRadialProfileGauss::classname ( void  ) const
inlinevirtual

Return class name.

Returns
String containing the class name ("GModelSpatialRadialProfileGauss").

Implements GModelSpatialRadialProfile.

Definition at line 93 of file GModelSpatialRadialProfileGauss.hpp.

void GModelSpatialRadialProfileGauss::clear ( void  )
virtual
GModelSpatialRadialProfileGauss * GModelSpatialRadialProfileGauss::clone ( void  ) const
virtual

Clone radial Gaussian profile model.

Returns
Pointer to deep copy of radial Gaussian profile model.

Returns a deep copy of the radial Gaussian profile model.

Implements GModelSpatialRadialProfile.

Definition at line 236 of file GModelSpatialRadialProfileGauss.cpp.

References GModelSpatialRadialProfileGauss().

void GModelSpatialRadialProfileGauss::copy_members ( const GModelSpatialRadialProfileGauss model)
protected

Copy class members.

Parameters
[in]modelRadial Gaussian model.

Copies class members from another radial profile model.

Definition at line 400 of file GModelSpatialRadialProfileGauss.cpp.

References m_sigma.

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

void GModelSpatialRadialProfileGauss::free_members ( void  )
protected

Delete class members.

Definition at line 415 of file GModelSpatialRadialProfileGauss.cpp.

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

GModelSpatialRadialProfileGauss & GModelSpatialRadialProfileGauss::operator= ( const GModelSpatialRadialProfileGauss model)
virtual

Assignment operator.

Parameters
[in]modelRadial Gaussian profile model.
Returns
Radial Gaussian profile model.

Assigns radial Gaussian profile model.

Definition at line 175 of file GModelSpatialRadialProfileGauss.cpp.

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

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

Print information.

Parameters
[in]chatterChattiness (defaults to NORMAL).
Returns
String containing model information.

Implements GModelSpatialRadialProfile.

Definition at line 335 of file GModelSpatialRadialProfileGauss.cpp.

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

double GModelSpatialRadialProfileGauss::profile_value ( const double &  theta) const
protectedvirtual

Radial profile.

Parameters
[in]thetaAngular distance from Gaussian centre (radians).
Returns
Profile value.

Implements GModelSpatialRadialProfile.

Definition at line 428 of file GModelSpatialRadialProfileGauss.cpp.

References gammalib::deg2rad, exp(), m_sigma, gammalib::twopi, and GOptimizerPar::value().

void GModelSpatialRadialProfileGauss::read ( const GXmlElement xml)
virtual

Read model from XML element.

Parameters
[in]xmlXML element.

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

<spatialModel type="GaussianProfile">
  <parameter name="RA"    scale="1.0" value="83.6331" min="-360" max="360" free="1"/>
  <parameter name="DEC"   scale="1.0" value="22.0145" min="-90"  max="90"  free="1"/>
  <parameter name="Sigma" scale="1.0" value="0.45"    min="0.01" max="10"  free="1"/>
</spatialModel>

or

<spatialModel type="GaussianProfile">
  <parameter name="GLON"  scale="1.0" value="83.6331" min="-360" max="360" free="1"/>
  <parameter name="GLAT"  scale="1.0" value="22.0145" min="-90"  max="90"  free="1"/>
  <parameter name="Sigma" scale="1.0" value="0.45"    min="0.01" max="10"  free="1"/>
</spatialModel>

Reimplemented from GModelSpatialRadial.

Definition at line 287 of file GModelSpatialRadialProfileGauss.cpp.

References G_READ, m_sigma, GOptimizerPar::name(), GModelSpatialRadial::read(), GModelPar::read(), and gammalib::xml_get_par().

Referenced by GModelSpatialRadialProfileGauss().

double GModelSpatialRadialProfileGauss::sigma ( void  ) const
inline

Return Gaussian sigma.

Returns
Gaussian sigma (degrees).

Returns the Gaussian sigma in degrees.

Definition at line 121 of file GModelSpatialRadialProfileGauss.hpp.

References m_sigma, and GOptimizerPar::value().

Referenced by GModelSpatialRadialProfileGauss().

void GModelSpatialRadialProfileGauss::sigma ( const double &  sigma)
inline

Set Gaussian sigma.

Parameters
[in]sigmaGaussian sigma (degrees).

Sets the Gaussian sigma in degrees.

Definition at line 135 of file GModelSpatialRadialProfileGauss.hpp.

References m_sigma, and GOptimizerPar::value().

double GModelSpatialRadialProfileGauss::theta_max ( void  ) const
virtual

Return maximum model radius (in radians)

Returns
Maximum model radius (in radians).

Implements GModelSpatialRadialProfile.

Definition at line 258 of file GModelSpatialRadialProfileGauss.cpp.

References gammalib::deg2rad, m_sigma, and GOptimizerPar::value().

double GModelSpatialRadialProfileGauss::theta_min ( void  ) const
virtual

Return maximum model radius (in radians)

Returns
Maximum model radius (in radians).

Implements GModelSpatialRadialProfile.

Definition at line 247 of file GModelSpatialRadialProfileGauss.cpp.

std::string GModelSpatialRadialProfileGauss::type ( void  ) const
inlinevirtual

Return model type.

Returns
"GaussianProfile".

Returns the type of the radial profile model.

Implements GModelSpatialRadialProfile.

Definition at line 107 of file GModelSpatialRadialProfileGauss.hpp.

void GModelSpatialRadialProfileGauss::write ( GXmlElement xml) const
virtual

Write model into XML element.

Parameters
[in]xmlXML element into which model information is written.

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

<spatialModel type="GaussianProfile">
  <parameter name="RA"    scale="1.0" value="83.6331" min="-360" max="360" free="1"/>
  <parameter name="DEC"   scale="1.0" value="22.0145" min="-90"  max="90"  free="1"/>
  <parameter name="Sigma" scale="1.0" value="0.45"    min="0.01" max="10"  free="1"/>
</spatialModel>

Reimplemented from GModelSpatialRadial.

Definition at line 315 of file GModelSpatialRadialProfileGauss.cpp.

References G_WRITE, m_sigma, GOptimizerPar::name(), GModelSpatialRadial::write(), GModelPar::write(), and gammalib::xml_need_par().

Member Data Documentation

GModelPar GModelSpatialRadialProfileGauss::m_sigma
protected

Gaussian width (deg)

Definition at line 83 of file GModelSpatialRadialProfileGauss.hpp.

Referenced by copy_members(), init_members(), profile_value(), read(), sigma(), theta_max(), and write().


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