ctlikelihood.cpp
11.6 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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
/***************************************************************************
* ctlikelihood - Base class for likelihood tools *
* ----------------------------------------------------------------------- *
* copyright (C) 2016-2019 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 ctlikelihood.cpp
* @brief Likelihood tool base class implementation
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "ctlikelihood.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_EVALUATE "ctlikelihood::evaluate(GModelPar&, double&)"
/* __ Debug definitions __________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Name constructor
*
* @param[in] name Likelihood tool name.
* @param[in] version Likelihood tool version.
*
* Constructs a likelihood tool from the @p name and @p version. See the
* equivalent ctool constructor for details.
***************************************************************************/
ctlikelihood::ctlikelihood(const std::string& name,
const std::string& version) :
ctobservation(name, version)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Application parameters constructor
*
* @param[in] name Observation tool name.
* @param[in] version Observation tool version.
* @param[in] pars Application parameters.
*
* Constructs a likelihood tool from the @p name, @p version and the
* application parameters @p pars. See the equivalent ctool constructor
* for details.
***************************************************************************/
ctlikelihood::ctlikelihood(const std::string& name,
const std::string& version,
const GApplicationPars& pars) :
ctobservation(name, version, pars)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Command line constructor
*
* @param[in] name Likelihood tool name.
* @param[in] version Likelihood tool version.
* @param[in] argc Number of arguments in command line.
* @param[in] argv Array of command line arguments.
*
* Constructs a likelihood tool from the @p name, @p version and command
* line arguments. See the equivalent ctool constructor for details.
***************************************************************************/
ctlikelihood::ctlikelihood(const std::string& name,
const std::string& version,
int argc,
char *argv[]) :
ctobservation(name, version, argc, argv)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Observations constructor
*
* @param[in] name Likelihood tool name.
* @param[in] version Likelihood tool version.
* @param[in] obs Observation container.
*
* Constructs a likelihood tool from the @p name, @p version and an
* observation container.
***************************************************************************/
ctlikelihood::ctlikelihood(const std::string& name,
const std::string& version,
const GObservations& obs) :
ctobservation(name, version, obs)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] app Likelihood tool.
*
* Constructs an instance of a likelihood tool by copying information from
* another likelihood tool.
***************************************************************************/
ctlikelihood::ctlikelihood(const ctlikelihood& app) : ctobservation(app)
{
// Initialise members
init_members();
// Copy members
copy_members(app);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
*
* Destructs the likelihood tool.
***************************************************************************/
ctlikelihood::~ctlikelihood(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] app Likelihood tool.
* @return Likelihood tool.
*
* Assigns a likelihood tool.
***************************************************************************/
ctlikelihood& ctlikelihood::operator=(const ctlikelihood& app)
{
// Execute only if object is not identical
if (this != &app) {
// Copy base class members
this->ctobservation::operator=(app);
// Free members
free_members();
// Initialise members
init_members();
// Copy members
copy_members(app);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/*==========================================================================
= =
= Protected methods exposed in Python =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Evaluates the log-likelihood function
*
* @param[in] par Model parameter
* @param[in] value Model parameter factor value
* @return Log-likelihood function
*
* Evaluates the log-likelihood function at a given @p value.
***************************************************************************/
double ctlikelihood::evaluate(GModelPar& par, const double& value)
{
// Initialise log-likelihood value
double logL = 0.0;
// Throw an exception if the parameter is below the minimum boundary
if (par.has_min() && value < par.factor_min()) {
std::string msg = "Parameter \""+par.name()+"\" value"+
gammalib::str(value)+" is below its minimum boundary "+
gammalib::str(par.factor_min())+". To omit this "
"error please lower the minimum parameter boundary.";
throw GException::invalid_value(G_EVALUATE, msg);
}
// Throw an exception if the parameter is above the maximum boundary
if (par.has_max() && value > par.factor_max()) {
std::string msg = "Parameter \""+par.name()+"\" value"+
gammalib::str(value)+" is above its maximum boundary "+
gammalib::str(par.factor_max())+". To omit this "
"error please raise the maximum parameter boundary.";
throw GException::invalid_value(G_EVALUATE, msg);
}
// Change parameter factor
par.factor_value(value);
// Fix parameter
par.fix();
// Re-optimize log-likelihood
m_obs.optimize(m_opt);
// Free parameter
par.free();
// Retrieve log-likelihood
logL = m_obs.logL();
// Return log-likelihood
return logL;
}
/*==========================================================================
= =
= Protected methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void ctlikelihood::init_members(void)
{
// Initialise members
m_opt.clear();
// Initialise optimizer characteristics
m_opt.max_iter(50); // Maximum number of iterations
m_opt.max_stalls(10); // Maximum number of stalls
m_opt.eps(0.005); // Accuracy of maximum likelihood value
// Set optimizer characteristics from optional user parameters
if (has_par("like_accuracy")) {
m_opt.eps((*this)["like_accuracy"].real());
}
if (has_par("max_iter")) {
m_opt.max_iter((*this)["max_iter"].integer());
}
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] app Likelihood tool.
***************************************************************************/
void ctlikelihood::copy_members(const ctlikelihood& app)
{
// Copy members
m_opt = app.m_opt;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void ctlikelihood::free_members(void)
{
// Return
return;
}