GModelSpectralFunc.hpp
7.64 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
/***************************************************************************
* GModelSpectralFunc.hpp - Spectral function 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 GModelSpectralFunc.hpp
* @brief Spectral function model class definition
* @author Juergen Knoedlseder
*/
#ifndef GMODELSPECTRALFUNC_HPP
#define GMODELSPECTRALFUNC_HPP
/* __ Includes ___________________________________________________________ */
#include <vector>
#include <string>
#include "GModelPar.hpp"
#include "GModelSpectral.hpp"
#include "GEnergy.hpp"
#include "GXmlElement.hpp"
#include "GNodeArray.hpp"
/***********************************************************************//**
* @class GModelSpectralFunc
*
* @brief Spectral function model class
*
* This class implements an arbitrary function as the spectral model
* component. The model is defined by
*
* \f[
* S_{\rm E}(E | t) = {\tt m\_norm}
* \f]
*
* where
* - \f${\tt m\_norm}\f$ is the normalization of the function.
***************************************************************************/
class GModelSpectralFunc : public GModelSpectral {
public:
// Constructors and destructors
GModelSpectralFunc(void);
explicit GModelSpectralFunc(const std::string& filename,
const double& norm);
explicit GModelSpectralFunc(const GXmlElement& xml);
GModelSpectralFunc(const GModelSpectralFunc& model);
virtual ~GModelSpectralFunc(void);
// Operators
virtual GModelSpectralFunc& operator=(const GModelSpectralFunc& model);
// Implemented pure virtual base class methods
virtual void clear(void);
virtual GModelSpectralFunc* clone(void) const;
virtual std::string type(void) const;
virtual double eval(const GEnergy& srcEng,
const GTime& srcTime) const;
virtual double eval_gradients(const GEnergy& srcEng,
const GTime& srcTime);
virtual double flux(const GEnergy& emin,
const GEnergy& emax) const;
virtual double eflux(const GEnergy& emin,
const GEnergy& emax) const;
virtual GEnergy mc(const GEnergy& emin,
const GEnergy& emax,
const GTime& time,
GRan& ran) const;
virtual void read(const GXmlElement& xml);
virtual void write(GXmlElement& xml) const;
virtual std::string print(const GChatter& chatter = NORMAL) const;
// Other methods
const std::string& filename(void) const;
void filename(const std::string& filename);
double norm(void) const;
void norm(const double& norm);
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpectralFunc& model);
void free_members(void);
void load_nodes(const std::string& filename);
void set_cache(void) const;
void mc_update(const GEnergy& emin, const GEnergy& emax) const;
// Protected members
GModelPar m_norm; //!< Normalization factor
mutable GNodeArray m_lin_nodes; //!< Energy nodes of function
mutable GNodeArray m_log_nodes; //!< lof10(Energy) nodes of function
std::vector<double> m_lin_values; //!< Function values at nodes
std::vector<double> m_log_values; //!< log10(Function) values at nodes
std::string m_filename; //!< Name of file function
// Cached members used for pre-computations
mutable std::vector<double> m_prefactor; //!< Power-law normalisations
mutable std::vector<double> m_gamma; //!< Power-law indices
mutable std::vector<double> m_epivot; //!< Power-law pivot energies
mutable std::vector<double> m_flux; //!< Photon fluxes
mutable std::vector<double> m_eflux; //!< Energy fluxes
// Cached members for MC
mutable GEnergy m_mc_emin; //!< Minimum energy
mutable GEnergy m_mc_emax; //!< Maximum energy
mutable std::vector<double> m_mc_cum; //!< Cumulative distribution
mutable std::vector<double> m_mc_min; //!< Lower boundary for MC
mutable std::vector<double> m_mc_max; //!< Upper boundary for MC
mutable std::vector<double> m_mc_exp; //!< Exponent for MC
};
/***********************************************************************//**
* @brief Return model type
*
* @return "FileFunction".
*
* Returns the type of the spectral function model.
***************************************************************************/
inline
std::string GModelSpectralFunc::type(void) const
{
return "FileFunction";
}
/***********************************************************************//**
* @brief Return normalization factor
*
* @return Normalization factor.
*
* Returns the normalization factor.
***************************************************************************/
inline
double GModelSpectralFunc::norm(void) const
{
return (m_norm.value());
}
/***********************************************************************//**
* @brief Set normalization factor
*
* @param[in] norm Normalization factor.
*
* Sets the normalization factor.
***************************************************************************/
inline
void GModelSpectralFunc::norm(const double& norm)
{
m_norm.value(norm);
return;
}
/***********************************************************************//**
* @brief Return file name
*
* @return Name of node file.
*
* Returns the name of the file function node file.
***************************************************************************/
inline
const std::string& GModelSpectralFunc::filename(void) const
{
return (m_filename);
}
/***********************************************************************//**
* @brief Loads nodes from node file and set filename
*
* @param[in] filename Node file name.
*
* Loads the nodes from a file function node file and sets the filename.
***************************************************************************/
inline
void GModelSpectralFunc::filename(const std::string& filename)
{
load_nodes(filename);
return;
}
#endif /* GMODELSPECTRALFUNC_HPP */