GModelSpatial.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
/***************************************************************************
* GModelSpatial.hpp - Spatial model abstract base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2009-2021 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 GModelSpatial.hpp
* @brief Abstract spatial model base class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GMODELSPATIAL_HPP
#define GMODELSPATIAL_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GBase.hpp"
#include "GModelPar.hpp"
#include "GPhoton.hpp"
#include "GSkyDir.hpp"
#include "GSkyRegionCircle.hpp"
#include "GEnergy.hpp"
#include "GTime.hpp"
#include "GXmlElement.hpp"
#include "GRan.hpp"
#include "GFunction.hpp"
#include "GIntegral.hpp"
/* __ Forward declarations _______________________________________________ */
class GSkyRegion;
/***********************************************************************//**
* @class GModelSpatial
*
* @brief Abstract spatial model base class
*
* This class implements the spatial component of the factorized gamma-ray
* source model. The spatial component is given by
*
* \f[
* S_{\rm p}(\vec{p} | E, t)
* \f]
*
* where
* - \f$\vec{p}\f$ is the true photon arrival direction,
* - \f$E\f$ is the true photon energy, and
* - \f$t\f$ is the true photon arrival time.
*
* The spatial component describes the energy and time dependent morphology
* of the source. It satisfies
* \f[
* \int_{\Omega} S_{\rm p}(\vec{p} | E, t) d\Omega = 1
* \f]
* for all \f$E\f$ and \f$t\f$, hence the spatial component does not
* impact the spatially integrated spectral and temporal properties of the
* source.
***************************************************************************/
class GModelSpatial : public GBase {
public:
// Constructors and destructors
GModelSpatial(void);
GModelSpatial(const GModelSpatial& model);
virtual ~GModelSpatial(void);
// Operators
virtual GModelSpatial& operator=(const GModelSpatial& model);
virtual GModelPar& operator[](const int& index);
virtual const GModelPar& operator[](const int& index) const;
virtual GModelPar& operator[](const std::string& name);
virtual const GModelPar& operator[](const std::string& name) const;
// Pure virtual methods
virtual void clear(void) = 0;
virtual GModelSpatial* clone(void) const = 0;
virtual std::string classname(void) const = 0;
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;
// Virtual methods
virtual double flux(const GSkyRegion& region,
const GEnergy& srcEng = GEnergy(),
const GTime& srcTime = GTime()) const;
// Methods
std::string type(void) const;
void type(const std::string& type);
GModelPar& at(const int& index);
const GModelPar& at(const int& index) const;
bool has_par(const std::string& name) const;
bool has_free_pars(void) const;
int size(void) const;
void autoscale(void);
const GSkyRegion* region(void) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpatial& model);
void free_members(void);
virtual void set_region(void) const = 0;
// Kernel for circular sky region radial integration
class circle_int_kern_rho : public GFunction {
public:
circle_int_kern_rho(const GModelSpatial* model,
const GSkyRegionCircle* reg,
const GEnergy& srcEng,
const GTime& srcTime,
const double distance,
const double cosdist,
const double sindist,
const double modrad,
const double cosmodrad) :
m_model(model),
m_reg(reg),
m_srcEng(srcEng),
m_srcTime(srcTime),
m_dist(distance),
m_cosdist(cosdist),
m_sindist(sindist),
m_modrad(modrad),
m_cosmodrad(cosmodrad) { }
double eval(const double& rho);
public:
const GModelSpatial* m_model; //!< Spatial model
const GSkyRegionCircle* m_reg; //!< Integration region
GEnergy m_srcEng; //!< Photon energy
GTime m_srcTime; //!< Photon time
double m_dist; //!< Distance model-region (rad)
double m_cosdist; //!< Cos of distance model-region
double m_sindist; //!< Sin of distance model-region
double m_modrad; //!< Model radius (rad)
double m_cosmodrad; //!< Cos of model radius
};
// Kernel for circular sky region azimuth angle integration
class circle_int_kern_omega : public GFunction {
public:
circle_int_kern_omega(const GModelSpatial* model,
const GSkyRegionCircle* reg,
const double& rho,
const GEnergy& srcEng,
const GTime& srcTime) :
m_model(model),
m_reg(reg),
m_rho(rho),
m_srcEng(srcEng),
m_srcTime(srcTime) { }
double eval(const double& omega);
public:
const GModelSpatial* m_model; //!< Spatial model
const GSkyRegionCircle* m_reg; //!< Integration region
double m_rho; //!< Offset from center of the region
GEnergy m_srcEng; //!< Photon energy
GTime m_srcTime; //!< Photon time
};
// Proteced members
std::string m_type; //!< Spatial model type
GSkyRegionCircle m_region; //!< Bounding circle
std::vector<GModelPar*> m_pars; //!< Parameter pointers
};
/***********************************************************************//**
* @brief Return model type
*
* @return Model type.
*
* Returns the type of the spatial model.
***************************************************************************/
inline
std::string GModelSpatial::type(void) const
{
return (m_type);
}
/***********************************************************************//**
* @brief Set model type
*
* @param[in] type Model type.
*
* Set the type of the spatial model.
***************************************************************************/
inline
void GModelSpatial::type(const std::string& type)
{
m_type = type;
return;
}
/***********************************************************************//**
* @brief Returns model parameter
*
* @param[in] index Parameter index [0,...,size()-1].
* @return Model parameter.
*
* Returns model parameter without @p index range checking.
***************************************************************************/
inline
GModelPar& GModelSpatial::operator[](const int& index)
{
return *(m_pars[index]);
}
/***********************************************************************//**
* @brief Returns model parameter (const version)
*
* @param[in] index Parameter index [0,...,size()-1].
* @return Model parameter.
*
* Returns model parameter without @p index range checking.
***************************************************************************/
inline
const GModelPar& GModelSpatial::operator[](const int& index) const
{
return *(m_pars[index]);
}
/***********************************************************************//**
* @brief Return number of parameters
*
* @return Number of parameters in spatial model component.
*
* Returns the number of parameters in the spatial model component.
***************************************************************************/
inline
int GModelSpatial::size(void) const
{
return (int)m_pars.size();
}
/***********************************************************************//**
* @brief Return boundary sky region
*
* @return Boundary sky region.
*
* Returns a sky region that fully encloses the spatial model component.
***************************************************************************/
inline
const GSkyRegion* GModelSpatial::region(void) const
{
const_cast<GModelSpatial*>(this)->set_region();
return (&m_region);
}
#endif /* GMODELSPATIAL_HPP */