GXXXResponse.cpp
12.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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
/***************************************************************************
* GXXXResponse.cpp - [INSTRUMENT] response class *
* ----------------------------------------------------------------------- *
* copyright (C) [YEAR] by [AUTHOR] *
* ----------------------------------------------------------------------- *
* *
* 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 GXXXResponse.hpp
* @brief [INSTRUMENT] instrument response function class implementation
* @author [AUTHOR]
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <string>
#include <typeinfo>
#include "GException.hpp"
#include "GSource.hpp"
#include "GModelSpatialPointSource.hpp"
#include "GXXXResponse.hpp"
#include "GXXXObservation.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_IRF "GXXXResponse::irf(GEvent&, GSource&, GObservation&)"
#define G_NROI "GXXXResponse::nroi(GModelSky&, GEnergy&, GTime&, "\
"GObservation&)"
#define G_EBOUNDS "GXXXResponse::ebounds(GEnergy&)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/* __ Constants __________________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
*
* Creates an empty [INSTRUMENT] response.
***************************************************************************/
GXXXResponse::GXXXResponse(void) : GResponse()
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] rsp [INSTRUMENT] response.
**************************************************************************/
GXXXResponse::GXXXResponse(const GXXXResponse& rsp) : GResponse(rsp)
{
// Initialise members
init_members();
// Copy members
copy_members(rsp);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GXXXResponse::~GXXXResponse(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] rsp [INSTRUMENT] response.
* @return [INSTRUMENT] response.
*
* Assign [INSTRUMENT] response to this object. The assignment performs
* a deep copy of all information, hence the original object from which the
* assignment was made can be destroyed after this operation without any loss
* of information.
***************************************************************************/
GXXXResponse& GXXXResponse::operator=(const GXXXResponse& rsp)
{
// Execute only if object is not identical
if (this != &rsp) {
// Copy base class members
this->GResponse::operator=(rsp);
// Free members
free_members();
// Initialise members
init_members();
// Copy members
copy_members(rsp);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear instance
*
* Clears [INSTRUMENT] response by resetting all class members to an initial
* state. Any information that was present before will be lost.
***************************************************************************/
void GXXXResponse::clear(void)
{
// Free class members (base and derived classes, derived class first)
free_members();
this->GResponse::free_members();
// Initialise members
this->GResponse::init_members();
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Clone instance
*
* @return Pointer to deep copy of [INSTRUMENT] response.
***************************************************************************/
GXXXResponse* GXXXResponse::clone(void) const
{
return new GXXXResponse(*this);
}
/***********************************************************************//**
* @brief Return value of [INSTRUMENT] instrument response for a photon
*
* @param[in] event Observed event.
* @param[in] photon Incident photon.
* @param[in] obs Observation.
* @return Instrument response $\f(cm^2 sr^{-1})$\f
*
* @exception GException::invalid_argument
* Observation is not a [INSTRUMENT] observation.
*
* Returns the instrument response function for a given observed photon
* direction as function of the assumed true photon direction. The result
* is given by
*
* \f[
* R(p'|p) =
* \f]
*
* @todo Write down formula
* @todo Describe in detail how the response is computed.
* @todo Implement method.
***************************************************************************/
double GXXXResponse::irf(const GEvent& event,
const GPhoton& photon,
const GObservation& obs) const
{
// Extract [INSTRUMENT] observation
const GXXXObservation* observation = dynamic_cast<const GXXXObservation*>(&obs);
if (observation == NULL) {
std::string cls = std::string(typeid(&obs).name());
std::string msg = "Observation of type \""+cls+"\" is not a [INSTRUMENT] "
"observation. Please specify a [INSTRUMENT] observation "
"as argument.";
throw GException::invalid_argument(G_IRF, msg);
}
// TODO: Now comes the real magic, this is your job !!!
// Initialise IRF
double irf = 0.0;
// Compile option: Check for NaN/Inf
// TODO: Add any relevant information that may help you to debug the
// response code. You want to make sure that any NaN is signalled.
// This can be switched off upon configuration.
#if defined(G_NAN_CHECK)
if (gammalib::is_notanumber(irf) || gammalib::is_infinite(irf)) {
std::cout << "*** ERROR: GXXXResponse::irf:";
std::cout << " NaN/Inf encountered";
std::cout << " (irf=" << irf;
std::cout << ")";
std::cout << std::endl;
}
#endif
// Return IRF value
return irf;
}
/***********************************************************************//**
* @brief Return integral of event probability for a given sky model over ROI
*
* @param[in] model Sky model.
* @param[in] obsEng Observed photon energy.
* @param[in] obsTime Observed photon arrival time.
* @param[in] obs Observation.
* @return 0.0
*
* @exception GException::feature_not_implemented
* Method is not implemented.
***************************************************************************/
double GXXXResponse::nroi(const GModelSky& model,
const GEnergy& obsEng,
const GTime& obsTime,
const GObservation& obs) const
{
// Method is not implemented
std::string msg = "Spatial integration of sky model over the data space "
"is not implemented.";
throw GException::feature_not_implemented(G_NROI, msg);
// Return Npred
return (0.0);
}
/***********************************************************************//**
* @brief Return true energy boundaries for a specific observed energy
*
* @param[in] obsEnergy Observed Energy.
* @return True energy boundaries for given observed energy.
*
* @exception GException::feature_not_implemented
* Method is not implemented.
*
* @todo Implement this method if you need energy dispersion.
***************************************************************************/
GEbounds GXXXResponse::ebounds(const GEnergy& obsEnergy) const
{
// Initialise an empty boundary object
GEbounds ebounds;
// Throw an exception
std::string msg = "Energy dispersion not implemented.";
throw GException::feature_not_implemented(G_EBOUNDS, msg);
// Return energy boundaries
return ebounds;
}
/***********************************************************************//**
* @brief Print [INSTRUMENT] response information
*
* @param[in] chatter Chattiness.
* @return String containing [INSTRUMENT] response information.
***************************************************************************/
std::string GXXXResponse::print(const GChatter& chatter) const
{
// Initialise result string
std::string result;
// Continue only if chatter is not silent
if (chatter != SILENT) {
// Append header
result.append("=== GXXXResponse ===");
// Append information
// TODO: Add any relevant information
} // endif: chatter was not silent
// Return result
return result;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GXXXResponse::init_members(void)
{
// Initialise members
// TODO: Initialise all data members
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] rsp [INSTRUMENT] response function.
***************************************************************************/
void GXXXResponse::copy_members(const GXXXResponse& rsp)
{
// Copy members
// TODO: Copy all data members
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GXXXResponse::free_members(void)
{
// Return
return;
}