GModelSpatialDiffuseCube.hpp
7.56 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
/***************************************************************************
* GModelSpatialDiffuseCube.hpp - Spatial map cube model class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2013 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 "GModelPar.hpp"
#include "GSkyDir.hpp"
#include "GSkymap.hpp"
#include "GXmlElement.hpp"
/***********************************************************************//**
* @class GModelSpatialDiffuseCube
*
* @brief Spatial map cube model
*
* This class implements the spatial component of the factorized source
* model for a map cube. A map cube is a set of sky maps for different
* energies.
*
* @todo Loading not yet implemented. Introduce a loading flag to load cube
* only when it is required. This avoid unnecessary memory allocation.
* @todo eval() and eval_gradients() methods not yet implemented.
***************************************************************************/
class GModelSpatialDiffuseCube : public GModelSpatialDiffuse {
public:
// Constructors and destructors
GModelSpatialDiffuseCube(void);
explicit GModelSpatialDiffuseCube(const GXmlElement& xml);
explicit GModelSpatialDiffuseCube(const double& value,
const std::string& filename);
explicit GModelSpatialDiffuseCube(const double& value,
const GSkymap& map);
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 type(void) const;
virtual double eval(const GSkyDir& srcDir) const;
virtual double eval_gradients(const GSkyDir& srcDir) const;
virtual GSkyDir mc(GRan& ran) const;
virtual void read(const GXmlElement& xml);
virtual void write(GXmlElement& xml) const;
virtual std::string print(void) const;
// Other methods
double value(void) const;
void value(const double& value);
const std::string& filename(void) const;
void filename(const std::string& filename);
const GSkymap& cube(void) const;
void cube(const GSkymap& map);
bool isloaded(void) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpatialDiffuseCube& model);
void free_members(void);
// Protected members
GModelPar m_value; //!< Value
std::string m_filename; //!< Name of map cube
GSkymap m_cube; //!< Map cube
bool m_loaded; //!< Signals that map cube has been loaded
};
/***********************************************************************//**
* @brief Return spatial model type
*
* @return "MapCubeFunction".
*
* Returns the type of the spatial map cube model.
***************************************************************************/
inline
std::string GModelSpatialDiffuseCube::type(void) const
{
return "MapCubeFunction";
}
/***********************************************************************//**
* @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 std::string& 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 std::string& filename)
{
m_filename = filename;
return;
}
/***********************************************************************//**
* @brief Get map cube
*
* @return Map cube.
*
* Returns the file name of the spatial map cube model.
***************************************************************************/
inline
const GSkymap& GModelSpatialDiffuseCube::cube(void) const
{
return (m_cube);
}
/***********************************************************************//**
* @brief Set map cube
*
* @param[in] map Sky map.
*
* Set the map cube of the spatial map cube model.
***************************************************************************/
inline
void GModelSpatialDiffuseCube::cube(const GSkymap& map)
{
m_cube = map;
m_loaded = true;
return;
}
/***********************************************************************//**
* @brief Signal if map cube has been loaded
*
* @return True if map cube has been loaded, false otherwise.
*
* Signals if a map cube is present (either by loading it from a file or by
* assigning it from a GSkymap).
***************************************************************************/
inline
bool GModelSpatialDiffuseCube::isloaded(void) const
{
return (m_loaded);
}
#endif /* GMODELSPATIALDIFFUSECUBE_HPP */