GModelSpatialEllipticalGeneralGauss.hpp
7.75 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/***************************************************************************
* GModelSpatialEllipticalGeneralGauss.hpp - Generalised elliptical *
* Gaussian source model class *
* ----------------------------------------------------------------------- *
* copyright (C) 2022 by Luigi Tibaldo *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GModelSpatialEllipticalGeneralGauss.hpp
* @brief Generalised elliptical gaussian model class interface definition
* @author Luigi Tibaldo
*/
#ifndef GMODELSPATIALELLIPTICALGENERALGAUSS_HPP
#define GMODELSPATIALELLIPTICALGENERALGAUSS_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GModelSpatialElliptical.hpp"
#include "GModelPar.hpp"
/* __ Forward declarations _______________________________________________ */
class GEnergy;
class GTime;
class GPhoton;
class GRan;
class GSkyDir;
class GSkyRegion;
class GXmlElement;
/**************************************************************************
* @class GModelSpatialEllipticalGeneralGauss
*
* @brief Generalised elliptical gaussian source model class
*
* This class implements the spatial component of the factorised source
* model for an generalised elliptical Gaussian source, i.e. surface
* brightness according to an asymmetric generalised Gaussian.
***************************************************************************/
class GModelSpatialEllipticalGeneralGauss : public GModelSpatialElliptical {
public:
// Constructors and destructors
GModelSpatialEllipticalGeneralGauss(void);
GModelSpatialEllipticalGeneralGauss(const GSkyDir& dir,
const double& major,
const double& minor,
const double& posangle,
const double& ridx,
const std::string& coordsys = "CEL");
explicit GModelSpatialEllipticalGeneralGauss(const GXmlElement& xml);
GModelSpatialEllipticalGeneralGauss(const GModelSpatialEllipticalGeneralGauss& model);
virtual ~GModelSpatialEllipticalGeneralGauss(void);
// Operators
virtual GModelSpatialEllipticalGeneralGauss& operator=(const GModelSpatialEllipticalGeneralGauss& model);
// Implemented pure virtual base class methods
virtual void clear(void);
virtual GModelSpatialEllipticalGeneralGauss* clone(void) const;
virtual std::string classname(void) const;
virtual double eval(const double& theta,
const double& posangle,
const GEnergy& energy,
const GTime& time,
const bool& gradients = false) const;
virtual GSkyDir mc(const GEnergy& energy,
const GTime& time,
GRan& ran) const;
virtual bool contains(const GSkyDir& dir,
const double& margin = 0.0) const;
virtual double theta_max(void) const;
virtual void read(const GXmlElement& xml);
virtual void write(GXmlElement& xml) const;
virtual std::string print(const GChatter& chatter = NORMAL) const;
// Other methods
double ridx(void) const;
void ridx(const double& ridx);
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpatialEllipticalGeneralGauss& model);
void free_members(void);
void update(void) const;
virtual void set_region(void) const;
// Protected members
GModelPar m_ridx; //!< Reciprocal of exponent of the radial profile
// Cached members used for pre-computations
mutable double m_last_minor; //!< Last semi-minor axis
mutable double m_last_major; //!< Last semi-major axis
mutable double m_last_posangle; //!< Last position angle
mutable double m_cospos2; //!< squared cosine of position angle
mutable double m_sinpos2; //!< squared sine of position angle
mutable double m_sin2pos; //!< sine of twice the position angle
mutable double m_minor2; //!< square of minor axis
mutable double m_major2; //!< square of major axis
mutable double m_minor_rad; //!< Minor axis in radians
mutable double m_major_rad; //!< Major axis in radians
mutable double m_norm; //!< Normalization
mutable double m_term1; //!< Help term 1
mutable double m_term2; //!< Help term 2
mutable double m_term3; //!< Help term 3
mutable double m_last_ridx; //!< Last reciprocal radial index
mutable double m_inv_ridx; //!< Spatial profile index
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GModelSpatialEllipticalGeneralGauss").
***************************************************************************/
inline
std::string GModelSpatialEllipticalGeneralGauss::classname(void) const
{
return ("GModelSpatialEllipticalGeneralGauss");
}
/***********************************************************************//**
* @brief Return reciprocal of the elliptical profile index
*
* @return Reciprocal of the elliptical profile index.
*
* Returns the reciprocal of the elliptical profile index.
***************************************************************************/
inline
double GModelSpatialEllipticalGeneralGauss::ridx(void) const
{
return (m_ridx.value());
}
/***********************************************************************//**
* @brief Set reciprocal of the elliptical profile index
*
* @param[in] ridx Reciprocal of the elliptical profile index.
*
* Sets the reciprocal of the elliptical profile index.
***************************************************************************/
inline
void GModelSpatialEllipticalGeneralGauss::ridx(const double& ridx)
{
m_ridx.value(ridx);
return;
}
#endif /* GMODELSPATIALELLIPTICALGENERALGAUSS_HPP */