GModelSpatialDiffuseCube.hpp
10.2 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
/***************************************************************************
* GModelSpatialDiffuseCube.hpp - Spatial map cube model class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2020 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 GModelSpatialDiffuseCube.hpp
* @brief Spatial map cube model class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GMODELSPATIALDIFFUSECUBE_HPP
#define GMODELSPATIALDIFFUSECUBE_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GModelSpatialDiffuse.hpp"
#include "GModelSpectral.hpp"
#include "GModelSpectralNodes.hpp"
#include "GModelPar.hpp"
#include "GSkyDir.hpp"
#include "GSkyMap.hpp"
#include "GSkyRegionCircle.hpp"
#include "GNodeArray.hpp"
#include "GEbounds.hpp"
#include "GFilename.hpp"
/* __ Forward declarations _______________________________________________ */
class GFits;
class GEnergies;
class GXmlElement;
/***********************************************************************//**
* @class GModelSpatialDiffuseCube
*
* @brief Spatial map cube model
*
* This class implements the spatial component of the factorised source
* model for a map cube. A map cube is a set of sky maps for different
* energies. It is assumed that the pixels of the sky map are given in the
* units ph/cm2/s/sr/MeV.
***************************************************************************/
class GModelSpatialDiffuseCube : public GModelSpatialDiffuse {
public:
// Constructors and destructors
GModelSpatialDiffuseCube(void);
GModelSpatialDiffuseCube(const bool& dummy, const std::string& type);
explicit GModelSpatialDiffuseCube(const GXmlElement& xml);
GModelSpatialDiffuseCube(const GFilename& filename,
const double& value = 1.0);
GModelSpatialDiffuseCube(const GSkyMap& cube,
const GEnergies& energies,
const double& value = 1.0);
GModelSpatialDiffuseCube(const GModelSpatialDiffuseCube& model);
virtual ~GModelSpatialDiffuseCube(void);
// Operators
virtual GModelSpatialDiffuseCube& operator=(const GModelSpatialDiffuseCube& model);
// Implemented pure virtual methods
virtual void clear(void);
virtual GModelSpatialDiffuseCube* clone(void) const;
virtual std::string classname(void) const;
virtual double eval(const GPhoton& photon,
const bool& gradients = false) const;
virtual GSkyDir mc(const GEnergy& energy,
const GTime& time,
GRan& ran) const;
virtual double mc_norm(const GSkyDir& dir,
const double& radius) const;
virtual bool contains(const GSkyDir& dir,
const double& margin = 0.0) 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 value(void) const;
void value(const double& value);
const GFilename& filename(void) const;
void filename(const GFilename& filename);
const GSkyMap& cube(void) const;
void cube(const GSkyMap& cube);
GEnergies energies(void);
void energies(const GEnergies& energies);
const GModelSpectralNodes& spectrum(void) const;
void mc_cone(const GSkyRegionCircle& cone) const;
const GSkyRegionCircle& mc_cone(void) const;
void load(const GFilename& filename);
void save(const GFilename& filename,
const bool& clobber = false) const;
void read(const GFits& fits);
void write(GFits& fits) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpatialDiffuseCube& model);
void free_members(void);
void fetch_cube(void) const;
void load_cube(const GFilename& filename);
void set_energy_boundaries(void);
void update_mc_cache(void);
double cube_intensity(const GPhoton& photon) const;
virtual void set_region(void) const;
// Protected members
GModelPar m_value; //!< Value
GFilename m_filename; //!< Name of map cube
bool m_loaded; //!< Signals if map cube has been loaded
GSkyMap m_cube; //!< Map cube
GNodeArray m_logE; //!< Log10(energy) values of the maps
GEbounds m_ebounds; //!< Energy bounds of the maps
// Monte Carlo cache
mutable GSkyRegionCircle m_mc_cone; //!< MC cone
mutable double m_mc_one_minus_cosrad; //!< 1-cosine of radius
mutable std::vector<double> m_mc_max; //!< Maximum values for MC
mutable GModelSpectralNodes m_mc_spectrum; //!< Map cube spectrum
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GModelSpatialDiffuseCube").
***************************************************************************/
inline
std::string GModelSpatialDiffuseCube::classname(void) const
{
return ("GModelSpatialDiffuseCube");
}
/***********************************************************************//**
* @brief Get model value
*
* @return Model value.
*
* Returns the value of the spatial map cube model.
***************************************************************************/
inline
double GModelSpatialDiffuseCube::value(void) const
{
return (m_value.value());
}
/***********************************************************************//**
* @brief Set model value
*
* @param[in] value Model value.
*
* Set the value of the spatial map cube model.
***************************************************************************/
inline
void GModelSpatialDiffuseCube::value(const double& value)
{
m_value.value(value);
return;
}
/***********************************************************************//**
* @brief Get file name
*
* @return File name.
*
* Returns the file name of the spatial map cube model.
***************************************************************************/
inline
const GFilename& GModelSpatialDiffuseCube::filename(void) const
{
return (m_filename);
}
/***********************************************************************//**
* @brief Set file name
*
* @param[in] filename File name.
*
* Set the file name of the spatial map cube model.
***************************************************************************/
inline
void GModelSpatialDiffuseCube::filename(const GFilename& filename)
{
m_filename = filename;
return;
}
/***********************************************************************//**
* @brief Get map cube
*
* @return Map cube.
*
* Returns the map cube.
***************************************************************************/
inline
const GSkyMap& GModelSpatialDiffuseCube::cube(void) const
{
fetch_cube();
return (m_cube);
}
/***********************************************************************//**
* @brief Get map cube spectrum
*
* @return Map cube spectrum.
*
* Returns the map cube spectrum.
***************************************************************************/
inline
const GModelSpectralNodes& GModelSpatialDiffuseCube::spectrum(void) const
{
fetch_cube();
return (m_mc_spectrum);
}
/***********************************************************************//**
* @brief Return normalization of diffuse cube for Monte Carlo simulations
*
* @param[in] dir Centre of simulation cone.
* @param[in] radius Radius of simulation cone (degrees).
* @return Normalization.
*
* Returns the normalization of a diffuse cube. The normalization is given
* by the model value. The @p dir and @p radius parameters are not used.
***************************************************************************/
inline
double GModelSpatialDiffuseCube::mc_norm(const GSkyDir& dir,
const double& radius) const
{
return (value());
}
/***********************************************************************//**
* @brief Get Monte Carlo simulation cone
*
* @return Monte Carlo simulation sky region circle.
*
* Returns the sky region circle used for Monte Carlo simulations.
***************************************************************************/
inline
const GSkyRegionCircle& GModelSpatialDiffuseCube::mc_cone(void) const
{
return (m_mc_cone);
}
#endif /* GMODELSPATIALDIFFUSECUBE_HPP */