GModelSpatialComposite.hpp
7.26 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
/***************************************************************************
* GModelSpatialPointSource.hpp - Spatial point source model class *
* ----------------------------------------------------------------------- *
* copyright (C) 2016-2017 by Domenico Tiziani *
* ----------------------------------------------------------------------- *
* *
* 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 GModelSpatialComposite.hpp
* @brief Spatial composite model class interface definition
* @author Domenico Tiziani
*/
#ifndef GMODELSPATIALCOMPOSITE_HPP
#define GMODELSPATIALCOMPOSITE_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GModelSpatial.hpp"
#include "GModelPar.hpp"
#include "GSkyDir.hpp"
#include "GSkyRegionCircle.hpp"
#include "GXmlElement.hpp"
/***********************************************************************//**
* @class GModelSpatialComposite
*
* @brief Spatial composite model
*
* This class implements the spatial model for a composition of spatial
* models.
***************************************************************************/
class GModelSpatialComposite : public GModelSpatial {
public:
// Constructors and destructors
GModelSpatialComposite(void);
GModelSpatialComposite(const bool& dummy, const std::string& type);
explicit GModelSpatialComposite(const GXmlElement& xml);
GModelSpatialComposite(const GModelSpatialComposite& model);
virtual ~GModelSpatialComposite(void);
// Operators
virtual GModelSpatialComposite& operator=(const GModelSpatialComposite& model);
// Implemented pure virtual methods
virtual void clear(void);
virtual GModelSpatialComposite* clone(void) const;
virtual std::string classname(void) const;
virtual std::string type(void) const;
virtual GClassCode code(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
int components(void) const;
void append(const GModelSpatial& component,
const std::string& name = "",
const GModelPar& par = GModelPar("", 1.0));
const GModelSpatial* component(const int& index) const;
const GModelSpatial* component(const std::string& name) const;
double scale(const int& index) const;
double sum_of_scales(void) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpatialComposite& model);
void free_members(void);
void set_region(void) const;
// Protected members
std::string m_type; //!< Model type
std::vector<GModelSpatial*> m_components; //!< Components
std::vector<std::string> m_names; //!< Component names
std::vector<GModelPar> m_scales; //!< Component scales
mutable GSkyRegionCircle m_region; //!< Bounding circle
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GModelSpatialComposite").
***************************************************************************/
inline
std::string GModelSpatialComposite::classname(void) const
{
return ("GModelSpatialComposite");
}
/***********************************************************************//**
* @brief Return model type
*
* @return Model type.
*
* Returns the type of the spatial model.
***************************************************************************/
inline
std::string GModelSpatialComposite::type(void) const
{
return (m_type);
}
/***********************************************************************//**
* @brief Return class code
*
* @return GModelSpatialComposite.
*
* Returns the code GModelSpatialComposite of the class.
***************************************************************************/
inline
GClassCode GModelSpatialComposite::code(void) const
{
return GMODEL_SPATIAL_COMPOSITE;
}
/***********************************************************************//**
* @brief Return normalization of composite source for Monte Carlo
* simulations
*
* @param[in] dir Centre of simulation cone.
* @param[in] radius Radius of simulation cone (degrees).
* @return Normalization.
*
* Returns unity.
***************************************************************************/
inline
double GModelSpatialComposite::mc_norm(const GSkyDir& dir,
const double& radius) const
{
return 1.0;
}
/***********************************************************************//**
* @brief Return number of model components
*
* @return Number of model components.
***************************************************************************/
inline
int GModelSpatialComposite::components(void) const
{
return m_components.size();
}
/***********************************************************************//**
* @brief Return boundary sky region
*
* @return Boundary sky region.
*
* Returns a sky region that fully encloses the point source.
***************************************************************************/
inline
GSkyRegion* GModelSpatialComposite::region(void) const
{
set_region();
return (&m_region);
}
#endif /* GMODELSPATIALCOMPOSITE_HPP */