GModelSpatialDiffuseMap.hpp
8.62 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
/***************************************************************************
* GModelSpatialDiffuseMap.hpp - Spatial map model class *
* ----------------------------------------------------------------------- *
* copyright (C) 2012-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 GModelSpatialDiffuseMap.hpp
* @brief Spatial map model class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GMODELSPATIALDIFFUSEMAP_HPP
#define GMODELSPATIALDIFFUSEMAP_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GModelSpatialDiffuse.hpp"
#include "GModelPar.hpp"
#include "GSkyDir.hpp"
#include "GSkyMap.hpp"
#include "GSkyRegionCircle.hpp"
#include "GXmlElement.hpp"
#include "GFilename.hpp"
/***********************************************************************//**
* @class GModelSpatialDiffuseMap
*
* @brief Spatial map model
*
* This class implements the spatial component of the factorised source
* model for a skymap.
***************************************************************************/
class GModelSpatialDiffuseMap : public GModelSpatialDiffuse {
public:
// Constructors and destructors
GModelSpatialDiffuseMap(void);
GModelSpatialDiffuseMap(const bool& dummy, const std::string& type);
explicit GModelSpatialDiffuseMap(const GXmlElement& xml);
GModelSpatialDiffuseMap(const GFilename& filename,
const double& value = 1.0,
const bool& normalize = true);
GModelSpatialDiffuseMap(const GSkyMap& map,
const double& value = 1.0,
const bool& normalize = true);
GModelSpatialDiffuseMap(const GModelSpatialDiffuseMap& model);
virtual ~GModelSpatialDiffuseMap(void);
// Operators
virtual GModelSpatialDiffuseMap& operator=(const GModelSpatialDiffuseMap& model);
// Implemented pure virtual methods
virtual void clear(void);
virtual GModelSpatialDiffuseMap* 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;
// Overloaded base class methods
virtual double flux(const GSkyRegion& region,
const GEnergy& srcEng = GEnergy(),
const GTime& srcTime = GTime()) const;
// Other methods
double value(void) const;
void value(const double& value);
const GFilename& filename(void) const;
void load(const GFilename& filename);
const GSkyMap& map(void) const;
void map(const GSkyMap& map);
bool normalize(void) const;
void mc_cone(const GSkyRegionCircle& cone) const;
const GSkyRegionCircle& mc_cone(void) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpatialDiffuseMap& model);
void free_members(void);
void prepare_map(void);
virtual void set_region(void) const;
// Protected members
GModelPar m_value; //!< Value
GSkyMap m_map; //!< Skymap
GFilename m_filename; //!< Name of skymap
bool m_normalize; //!< Normalize map (default: true)
bool m_has_normalize; //!< XML has normalize attribute
// MC simulation cache
mutable GSkyRegionCircle m_mc_cone; //!< MC cone
mutable double m_mc_one_minus_cosrad; //!< 1-cosine of radius
mutable double m_mc_norm; //!< Map normalization
mutable double m_mc_max; //!< Map maximum for MC
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GModelSpatialDiffuseMap").
***************************************************************************/
inline
std::string GModelSpatialDiffuseMap::classname(void) const
{
return ("GModelSpatialDiffuseMap");
}
/***********************************************************************//**
* @brief Get model value
*
* @return Model value.
*
* Returns the value of the spatial map model.
***************************************************************************/
inline
double GModelSpatialDiffuseMap::value(void) const
{
return (m_value.value());
}
/***********************************************************************//**
* @brief Set model value
*
* @param[in] value Model value.
*
* Set the value of the spatial map model.
***************************************************************************/
inline
void GModelSpatialDiffuseMap::value(const double& value)
{
m_value.value(value);
return;
}
/***********************************************************************//**
* @brief Get file name
*
* @return File name.
*
* Returns the file name of the spatial map model.
***************************************************************************/
inline
const GFilename& GModelSpatialDiffuseMap::filename(void) const
{
return (m_filename);
}
/***********************************************************************//**
* @brief Get map
*
* @return Sky map.
*
* Returns the sky map.
***************************************************************************/
inline
const GSkyMap& GModelSpatialDiffuseMap::map(void) const
{
return (m_map);
}
/***********************************************************************//**
* @brief Set map cube
*
* @param[in] map Sky map.
*
* Set the sky map.
***************************************************************************/
inline
void GModelSpatialDiffuseMap::map(const GSkyMap& map)
{
m_map = map;
prepare_map();
return;
}
/***********************************************************************//**
* @brief Return normalization flag
*
* @return True if the map has been normalized, false otherwise.
*
* Signals whether a map has been normalized or not.
***************************************************************************/
inline
bool GModelSpatialDiffuseMap::normalize(void) const
{
return (m_normalize);
}
/***********************************************************************//**
* @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& GModelSpatialDiffuseMap::mc_cone(void) const
{
return (m_mc_cone);
}
#endif /* GMODELSPATIALDIFFUSEMAP_HPP */