GModelSpatialElliptical.hpp
10.7 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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
/***************************************************************************
* GModelSpatialElliptical.hpp - Abstract elliptical spatial model class *
* ----------------------------------------------------------------------- *
* copyright (C) 2013-2016 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* 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 GModelSpatialElliptical.hpp
* @brief Abstract elliptical spatial model base class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GMODELSPATIALELLIPTICAL_HPP
#define GMODELSPATIALELLIPTICAL_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GModelSpatial.hpp"
#include "GModelPar.hpp"
#include "GSkyDir.hpp"
#include "GEnergy.hpp"
#include "GTime.hpp"
#include "GPhoton.hpp"
#include "GXmlElement.hpp"
#include "GRan.hpp"
/***********************************************************************//**
* @class GModelSpatialElliptical
*
* @brief Abstract elliptical spatial model base class
*
* This class defines the interface for an elliptical model as spatial
* component of the factorized source model. Typical examples of elliptical
* components are elliptical Disk, Gaussian or Shell shaped sources.
***************************************************************************/
class GModelSpatialElliptical : public GModelSpatial {
public:
// Constructors and destructors
GModelSpatialElliptical(void);
GModelSpatialElliptical(const GModelSpatialElliptical& model);
explicit GModelSpatialElliptical(const GXmlElement& xml);
virtual ~GModelSpatialElliptical(void);
// Operators
virtual GModelSpatialElliptical& operator=(const GModelSpatialElliptical& model);
// Pure virtual methods
virtual void clear(void) = 0;
virtual GModelSpatialElliptical* clone(void) const = 0;
virtual std::string classname(void) const = 0;
virtual std::string type(void) const = 0;
virtual double eval(const double& theta,
const double& posangle,
const GEnergy& energy,
const GTime& time,
const bool& gradients = false) const = 0;
virtual GSkyDir mc(const GEnergy& energy,
const GTime& time,
GRan& ran) const = 0;
virtual bool contains(const GSkyDir& dir,
const double& margin = 0.0) const = 0;
virtual double theta_max(void) const = 0;
virtual std::string print(const GChatter& chatter = NORMAL) const = 0;
// Implemented virtual base class methods
virtual GClassCode code(void) const;
virtual double eval(const GPhoton& photon,
const bool& gradients = false) const;
virtual double mc_norm(const GSkyDir& dir, const double& radius) const;
virtual void read(const GXmlElement& xml);
virtual void write(GXmlElement& xml) const;
// Other methods
double ra(void) const;
double dec(void) const;
void ra(const double& ra);
void dec(const double& dec);
double posangle(void) const;
void posangle(const double& posangle);
double semiminor(void) const;
double semimajor(void) const;
void semiminor(const double& semiminor);
void semimajor(const double& semimajor);
GSkyDir dir(void) const;
void dir(const GSkyDir& dir);
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpatialElliptical& model);
void free_members(void);
// Proteced members
GModelPar m_ra; //!< Right Ascension (deg)
GModelPar m_dec; //!< Declination (deg)
GModelPar m_posangle; //!< Position angle from North, counterclockwise (deg)
GModelPar m_semiminor; //!< Semi-minor axis of ellipse (deg)
GModelPar m_semimajor; //!< Semi-major axis of ellipse (deg)
};
/***********************************************************************//**
* @brief Return class code
*
* @return GModelSpatialElliptical.
*
* Returns the code GModelSpatialElliptical of the class.
***************************************************************************/
inline
GClassCode GModelSpatialElliptical::code(void) const
{
return GMODEL_SPATIAL_ELLIPTICAL;
}
/***********************************************************************//**
* @brief Return Right Ascencion of model centre
*
* @return Right Ascencion of model centre (degrees).
*
* Returns the Right Ascension of the model centre in degrees.
***************************************************************************/
inline
double GModelSpatialElliptical::ra(void) const
{
return (m_ra.value());
}
/***********************************************************************//**
* @brief Set Right Ascencion of model centre
*
* @param[in] ra Right Ascension (degrees).
*
* Sets the Right Ascension of the model centre in degrees.
***************************************************************************/
inline
void GModelSpatialElliptical::ra(const double& ra)
{
m_ra.value(ra);
return;
}
/***********************************************************************//**
* @brief Return Declination of model centre
*
* @return Declination of model centre (degrees).
*
* Returns the Declination of the model centre in degrees.
***************************************************************************/
inline
double GModelSpatialElliptical::dec(void) const
{
return (m_dec.value());
}
/***********************************************************************//**
* @brief Set Declination of model centre
*
* @param[in] dec Declination (degrees).
*
* Sets the Declination of the model centre in degrees.
***************************************************************************/
inline
void GModelSpatialElliptical::dec(const double& dec)
{
m_dec.value(dec);
return;
}
/***********************************************************************//**
* @brief Return Position Angle of model
*
* @return Position Angle of model (degrees).
*
* Returns the Position Angle of model in degrees, measured counterclockwise
* from celestial North.
***************************************************************************/
inline
double GModelSpatialElliptical::posangle(void) const
{
return (m_posangle.value());
}
/***********************************************************************//**
* @brief Set Position Angle of model
*
* @param[in] posangle Position Angle of model (degrees).
*
* Sets the Position Angle of model in degrees, measured counterclockwise
* from celestial North.
***************************************************************************/
inline
void GModelSpatialElliptical::posangle(const double& posangle)
{
m_posangle.value(posangle);
return;
}
/***********************************************************************//**
* @brief Return semi-minor axis of ellipse
*
* @return Semi-minor axis of ellipse (degrees).
*
* Returns the semi-minor axis of the ellipse in degrees.
***************************************************************************/
inline
double GModelSpatialElliptical::semiminor(void) const
{
return (m_semiminor.value());
}
/***********************************************************************//**
* @brief Set semi-minor axis of ellipse
*
* @param[in] semiminor Semi-minor axis of ellipse (degrees)
*
* Sets the semi-minor axis of the ellipse in degrees.
***************************************************************************/
inline
void GModelSpatialElliptical::semiminor(const double& semiminor)
{
m_semiminor.value(semiminor);
return;
}
/***********************************************************************//**
* @brief Return semi-major axis of ellipse
*
* @return Semi-major axis of ellipse (degrees).
*
* Returns the semi-major axis of the ellipse in degrees.
***************************************************************************/
inline
double GModelSpatialElliptical::semimajor(void) const
{
return (m_semimajor.value());
}
/***********************************************************************//**
* @brief Set semi-major axis of ellipse
*
* @param[in] semimajor Semi-major axis of ellipse (degrees)
*
* Sets the semi-major axis of the ellipse in degrees.
***************************************************************************/
inline
void GModelSpatialElliptical::semimajor(const double& semimajor)
{
m_semimajor.value(semimajor);
return;
}
/***********************************************************************//**
* @brief Return normalization of elliptical source for Monte Carlo
* simulations
*
* @param[in] dir Centre of simulation cone.
* @param[in] radius Radius of simulation cone (degrees).
* @return Normalization.
*
* Returns the normalization for an elliptical source within a circular
* region. The normalization is 1 if the elliptical source falls within
* the circle define by @p dir and @p radius, 0 otherwise.
***************************************************************************/
inline
double GModelSpatialElliptical::mc_norm(const GSkyDir& dir,
const double& radius) const
{
double norm = (dir.dist_deg(this->dir()) <= radius+theta_max()) ? 1.0 : 0.0;
return (norm);
}
#endif /* GMODELSPATIALELLIPTICAL_HPP */