GModelSpatialDiffuseConst.hpp
7.27 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
/***************************************************************************
* GModelSpatialDiffuseConst.hpp - Spatial isotropic model class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-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 GModelSpatialDiffuseConst.hpp
* @brief Isotropic spatial model class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GMODELSPATIALDIFFUSECONST_HPP
#define GMODELSPATIALDIFFUSECONST_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GModelSpatialDiffuse.hpp"
#include "GModelPar.hpp"
#include "GSkyDir.hpp"
#include "GSkyRegionCircle.hpp"
#include "GXmlElement.hpp"
/***********************************************************************//**
* @class GModelSpatialDiffuseConst
*
* @brief Isotropic spatial model
*
* This class implements the spatial component of the factorised source
* model for an isotropic source. The model has a single parameter which
* is the normalization factor of the model.
***************************************************************************/
class GModelSpatialDiffuseConst : public GModelSpatialDiffuse {
public:
// Constructors and destructors
GModelSpatialDiffuseConst(void);
GModelSpatialDiffuseConst(const bool& dummy, const std::string& type);
explicit GModelSpatialDiffuseConst(const GXmlElement& xml);
explicit GModelSpatialDiffuseConst(const double& value);
GModelSpatialDiffuseConst(const GModelSpatialDiffuseConst& model);
virtual ~GModelSpatialDiffuseConst(void);
// Operators
GModelSpatialDiffuseConst& operator=(const GModelSpatialDiffuseConst& model);
// Implemented pure virtual base class methods
virtual void clear(void);
virtual GModelSpatialDiffuseConst* clone(void) const;
virtual std::string classname(void) const;
virtual std::string type(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 GSkyRegion* region(void) 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);
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpatialDiffuseConst& model);
void free_members(void);
void set_region(void) const;
// Protected members
std::string m_type; //!< Model type
GModelPar m_value; //!< Value
mutable GSkyRegionCircle m_region; //!< Bounding circle
mutable GSkyDir m_mc_centre; //!< Simulation cone centre
mutable double m_mc_cos_radius; //!< Cosine of sim. cone radius
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GModelSpatialDiffuseConst").
***************************************************************************/
inline
std::string GModelSpatialDiffuseConst::classname(void) const
{
return ("GModelSpatialDiffuseConst");
}
/***********************************************************************//**
* @brief Return spatial model type
*
* @return Model type.
*
* Returns the type of the isotropic spatial model.
***************************************************************************/
inline
std::string GModelSpatialDiffuseConst::type(void) const
{
return (m_type);
}
/***********************************************************************//**
* @brief Get model value
*
* @return Model value.
*
* Returns the value of the isotropic spatial model.
***************************************************************************/
inline
double GModelSpatialDiffuseConst::value(void) const
{
return (m_value.value());
}
/***********************************************************************//**
* @brief Set model value
*
* @param[in] value Model value.
*
* Set the value of the isotropic spatial model.
***************************************************************************/
inline
void GModelSpatialDiffuseConst::value(const double& value)
{
m_value.value(value);
return;
}
/***********************************************************************//**
* @brief Signals whether model contains sky direction
*
* @param[in] dir Sky direction.
* @param[in] margin Margin to be added to sky direction (deg, default: 0.0).
* @return True.
*
* Signals whether a sky direction falls within the bounding circle of
* the diffuse model. As the constant model is defined on the entire sphere,
* the method returns always true.
***************************************************************************/
inline
bool GModelSpatialDiffuseConst::contains(const GSkyDir& dir,
const double& margin) const
{
return (true);
}
/***********************************************************************//**
* @brief Return boundary sky region
*
* @return Boundary sky region.
*
* Returns a sky region that fully encloses the point source.
***************************************************************************/
inline
GSkyRegion* GModelSpatialDiffuseConst::region(void) const
{
set_region();
return (&m_region);
}
#endif /* GMODELSPATIALDIFFUSECONST_HPP */