GCOMResponse.cpp
16.5 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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
/***************************************************************************
* GCOMResponse.cpp - COMPTEL Response class *
* ----------------------------------------------------------------------- *
* copyright (C) 2012 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 GCOMResponse.cpp
* @brief COMPTEL response class implementation
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <string>
#include "GTools.hpp"
#include "GFits.hpp"
#include "GCaldb.hpp"
#include "GCOMResponse.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_IRF "GCOMResponse::irf(GInstDir&,GEnergy&,GTime&,GSkyDir&,"\
"GEnergy&,GTime&,GObservation&)"
#define G_NPRED "GCOMResponse::npred(GSkyDir&,GEnergy&,GTime&,"\
"GObservation&)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/* __ Constants __________________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
*
* Creates an empty COMPTEL response.
***************************************************************************/
GCOMResponse::GCOMResponse(void) : GResponse()
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] rsp COM response.
**************************************************************************/
GCOMResponse::GCOMResponse(const GCOMResponse& rsp) : GResponse(rsp)
{
// Initialise members
init_members();
// Copy members
copy_members(rsp);
// Return
return;
}
/***********************************************************************//**
* @brief Response constructor
*
* @param[in] iaqname IAQ file name.
* @param[in] caldb Calibration database path (defaults to "").
*
* Create COMPTEL response by loading an IAQ file.
*
* If an empty string is passed as calibration database path, the method will
* use the CALDB environment variable to determine the calibration database
* path. This is done in the method GCOMResponse::caldb which makes use of a
* GCaldb object to locate the calibration database.
***************************************************************************/
GCOMResponse::GCOMResponse(const std::string& iaqname,
const std::string& caldb) : GResponse()
{
// Initialise members
init_members();
// Set calibration database
this->caldb(caldb);
// Load IRF
this->load(iaqname);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
*
* Destroys instance of COMPTEL response object.
***************************************************************************/
GCOMResponse::~GCOMResponse(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] rsp COMPTEL response.
*
* Assigns COMPTEL response object to another COMPTEL response object. The
* assignment performs a deep copy of all information, hence the original
* object from which the assignment has been performed can be destroyed after
* this operation without any loss of information.
***************************************************************************/
GCOMResponse& GCOMResponse::operator=(const GCOMResponse& 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 COMPTEL response object by resetting all members to an initial
* state. Any information that was present in the object before will be lost.
***************************************************************************/
void GCOMResponse::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
*
* Creates a clone (deep copy) of a COMPTEL response object.
***************************************************************************/
GCOMResponse* GCOMResponse::clone(void) const
{
return new GCOMResponse(*this);
}
/***********************************************************************//**
* @brief Return value of instrument response function
*
* @param[in] obsDir Observed photon direction.
* @param[in] obsEng Observed energy of photon.
* @param[in] obsTime Observed photon arrival time.
* @param[in] srcDir True photon arrival direction.
* @param[in] srcEng True energy of photon.
* @param[in] srcTime True photon arrival time.
* @param[in] obs Observation.
***************************************************************************/
double GCOMResponse::irf(const GInstDir& obsDir,
const GEnergy& obsEng,
const GTime& obsTime,
const GSkyDir& srcDir,
const GEnergy& srcEng,
const GTime& srcTime,
const GObservation& obs) const
{
// Initialise IRF value
double irf = 0.0;
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (isnotanumber(irf) || isinfinite(irf)) {
std::cout << "*** ERROR: GCOMResponse::irf:";
std::cout << " NaN/Inf encountered";
std::cout << " (";
std::cout << "irf=" << irf;
std::cout << ")";
std::cout << std::endl;
}
#endif
// Return IRF value
return irf;
}
/***********************************************************************//**
* @brief Return spatial integral of point spread function
*
* @param[in] srcDir True photon arrival direction.
* @param[in] srcEng True energy of photon.
* @param[in] srcTime True photon arrival time.
* @param[in] obs Observation.
***************************************************************************/
double GCOMResponse::npred(const GSkyDir& srcDir,
const GEnergy& srcEng,
const GTime& srcTime,
const GObservation& obs) const
{
// Set dummp Npred value
double npred = 1.0;
// Compile option: Check for NaN/Inf
#if defined(G_NAN_CHECK)
if (isnotanumber(npred) || isinfinite(npred)) {
std::cout << "*** ERROR: GCOMResponse::npred:";
std::cout << " NaN/Inf encountered";
std::cout << " (";
std::cout << "npred=" << npred;
std::cout << ")";
std::cout << std::endl;
}
#endif
// Return Npred
return npred;
}
/***********************************************************************//**
* @brief Set path to the calibration database
*
* @param[in] caldb Path to calibration database
*
* This method stores the CALDB root directory as the path to the COMPTEL
* calibration database. Once the final calibration format has been decided
* on, this method should be adjusted.
***************************************************************************/
void GCOMResponse::caldb(const std::string& caldb)
{
// Allocate calibration database
GCaldb db(caldb);
// Store the path to the calibration database
m_caldb = db.dir();
// Return
return;
}
/***********************************************************************//**
* @brief Return path to the calibration database
***************************************************************************/
std::string GCOMResponse::caldb(void) const
{
// Return
return m_caldb;
}
/***********************************************************************//**
* @brief Load COMPTEL response.
*
* @param[in] iaqname Name of IAQ file.
*
* Load COMPTEL response from IAQ file.
***************************************************************************/
void GCOMResponse::load(const std::string& iaqname)
{
// Save calibration database name
std::string caldb = m_caldb;
// Clear instance
clear();
// Restore calibration database name
m_caldb = caldb;
// Save IAQ name
m_iaqname = iaqname;
// Build filename
std::string filename = m_caldb + "/" + m_iaqname;
// Open FITS file
GFits file(filename);
// Get IAQ image
GFitsImage* iaq = file.image(0);
// Read IAQ
read_iaq(iaq);
// Close ARF FITS file
file.close();
// Return
return;
}
/***********************************************************************//**
* @brief Read COMPTEL response from FITS image.
*
* @param[in] hdu FITS Image HDU.
*
* @todo Implement method
***************************************************************************/
void GCOMResponse::read_iaq(const GFitsImage* hdu)
{
// Continue only if header is valid
if (hdu != NULL) {
// Store IAQ dimensions
m_phigeo_bins = hdu->naxes(0);
m_phibar_bins = hdu->naxes(1);
// Store IAQ axes definitions
m_phigeo_ref_value = hdu->real("CRVAL1");
m_phigeo_ref_pixel = hdu->real("CRPIX1");
m_phigeo_bin_size = hdu->real("CDELT1");
m_phibar_ref_value = hdu->real("CRVAL2");
m_phibar_ref_pixel = hdu->real("CRPIX2");
m_phibar_bin_size = hdu->real("CDELT2");
// Compute IAQ size. Continue only if size is positive
int size = m_phigeo_bins * m_phibar_bins;
if (size > 0) {
// Allocate memory for IAQ
m_iaq.assign(size, 0.0);
// Copy over IAQ values
for (int i = 0; i < size; ++i) {
m_iaq[i] = hdu->pixel(i);
}
} // endif: size was positive
} // endif: HDU was valid
// Return
return;
}
/***********************************************************************//**
* @brief Print COMPTEL response information
***************************************************************************/
std::string GCOMResponse::print(void) const
{
// Initialise result string
std::string result;
// Append header
result.append("=== GCOMResponse ===");
result.append("\n"+parformat("Calibration database")+m_caldb);
result.append("\n"+parformat("IAQ file name")+m_iaqname);
result.append("\n"+parformat("Number of Phigeo bins")+str(m_phigeo_bins));
result.append("\n"+parformat("Number of Phibar bins")+str(m_phibar_bins));
result.append("\n"+parformat("Phigeo reference value")+str(m_phigeo_ref_value)+" deg");
result.append("\n"+parformat("Phigeo reference pixel")+str(m_phigeo_ref_pixel));
result.append("\n"+parformat("Phigeo bin size")+str(m_phigeo_bin_size)+" deg");
result.append("\n"+parformat("Phibar reference value")+str(m_phibar_ref_value)+" deg");
result.append("\n"+parformat("Phibar reference pixel")+str(m_phibar_ref_pixel));
result.append("\n"+parformat("Phibar bin size")+str(m_phibar_bin_size)+" deg");
// Return result
return result;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GCOMResponse::init_members(void)
{
// Initialise members
m_caldb.clear();
m_iaqname.clear();
m_iaq.clear();
m_phigeo_bins = 0;
m_phibar_bins = 0;
m_phigeo_ref_value = 0.0;
m_phigeo_ref_pixel = 0.0;
m_phigeo_bin_size = 0.0;
m_phibar_ref_value = 0.0;
m_phibar_ref_pixel = 0.0;
m_phibar_bin_size = 0.0;
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] rsp COMPTEL response.
***************************************************************************/
void GCOMResponse::copy_members(const GCOMResponse& rsp)
{
// Copy attributes
m_caldb = rsp.m_caldb;
m_iaqname = rsp.m_iaqname;
m_iaq = rsp.m_iaq;
m_phigeo_bins = rsp.m_phigeo_bins;
m_phibar_bins = rsp.m_phibar_bins;
m_phigeo_ref_value = rsp.m_phigeo_ref_value;
m_phigeo_ref_pixel = rsp.m_phigeo_ref_pixel;
m_phigeo_bin_size = rsp.m_phigeo_bin_size;
m_phibar_ref_value = rsp.m_phibar_ref_value;
m_phibar_ref_pixel = rsp.m_phibar_ref_pixel;
m_phibar_bin_size = rsp.m_phibar_bin_size;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GCOMResponse::free_members(void)
{
// Return
return;
}
/*==========================================================================
= =
= Friends =
= =
==========================================================================*/