GLATLtCube.cpp
16.9 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
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
/***************************************************************************
* GLATLtCube.cpp - Fermi/LAT livetime cube class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2014 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 GLATLtCube.cpp
* @brief Fermi/LAT livetime cube class implementation
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GLATLtCube.hpp"
#include "GTools.hpp"
/* __ Method name definitions ____________________________________________ */
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/* __ Constants __________________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GLATLtCube::GLATLtCube(void)
{
// Initialise class members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief File constructor
*
* @param[in] filename Livetime cube filename.
***************************************************************************/
GLATLtCube::GLATLtCube(const std::string& filename)
{
// Initialise class members
init_members();
// Load livetime cube from file
load(filename);
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] cube Livetime cube.
***************************************************************************/
GLATLtCube::GLATLtCube(const GLATLtCube& cube)
{
// Initialise class members
init_members();
// Copy members
copy_members(cube);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GLATLtCube::~GLATLtCube(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] cube Livetime cube.
* @return Livetime cube.
***************************************************************************/
GLATLtCube& GLATLtCube::operator=(const GLATLtCube& cube)
{
// Execute only if object is not identical
if (this != &cube) {
// Free members
free_members();
// Initialise private members
init_members();
// Copy members
copy_members(cube);
} // endif: object was not identical
// Return this object
return *this;
}
/***********************************************************************//**
* @brief Sum function multiplied by efficiency corrected livetime over
* zenith angle
*
* @param[in] dir Sky direction.
* @param[in] energy Energy.
* @param[in] fct Function to evaluate.
*
* Computes
* \f[\sum_{\cos \theta} T_{\rm corr.~live}(\cos \theta) f(\cos \theta)\f]
* where
* \f$T_{\rm corr.~live}(\cos \theta)\f$ is the efficiency corrected
* livetime as a function of the cosine of the zenith angle, and
* \f$f(\cos \theta)\f$ is a function that depends on the cosine of the
* zenith angle.
*
* Note that no efficieny correction is implemented for this method as the
* efficiency factors are stored together with the effective area. If we
* want efficiency correction here, we should think about passing this
* information to the method.
***************************************************************************/
double GLATLtCube::operator()(const GSkyDir& dir, const GEnergy& energy,
_ltcube_ctheta fct) const
{
// Compute exposure
double exposure = m_exposure(dir, fct);
// Optionally compute livetime factors for trigger rate- and
// energy-dependent efficiency corrections
/*
if (aeff.has_efficiency()) {
// Compute correction factors
double f1 = aeff.efficiency_factor1(energy);
double f2 = aeff.efficiency_factor2(energy);
// Compute correction
double correction = m_weighted_exposure(dir, fct);
// Set exposure
exposure = f1 * exposure + f2 * correction;
} // endif: corrections requested
*/
// Return exposure
return exposure;
}
/***********************************************************************//**
* @brief Sum function multiplied by efficiency corrected livetime over
* zenith and azimuth angles
*
* @param[in] dir Sky direction.
* @param[in] energy Energy.
* @param[in] fct Function to evaluate.
*
* Computes
* \f[\sum_{\cos \theta, \phi} T_{\rm corr.~live}(\cos \theta, \phi)
* f(\cos \theta, \phi)\f]
* where
* \f$T_{\rm corr.~live}(\cos \theta, \phi)\f$ is the efficiency corrected
* livetime as a function of the cosine of the zenith and of the azimuth
* angle, and
* \f$f(\cos \theta, \phi)\f$ is a function that depends on the cosine of
* the zenith angle and of the azimuth angle.
*
* Note that no efficieny correction is implemented for this method as the
* efficiency factors are stored together with the effective area. If we
* want efficiency correction here, we should think about passing this
* information to the method.
***************************************************************************/
double GLATLtCube::operator()(const GSkyDir& dir, const GEnergy& energy,
_ltcube_ctheta_phi fct) const
{
// Compute exposure
double exposure = m_exposure(dir, fct);
// Optionally compute livetime factors for trigger rate- and
// energy-dependent efficiency corrections
/*
if (aeff.has_efficiency()) {
// Compute correction factors
double f1 = aeff.efficiency_factor1(energy);
double f2 = aeff.efficiency_factor2(energy);
// Compute correction
double correction = m_weighted_exposure(dir, fct);
// Set exposure
exposure = f1 * exposure + f2 * correction;
} // endif: corrections requested
*/
// Return exposure
return exposure;
}
/***********************************************************************//**
* @brief Sum effective area multiplied by efficiency corrected livetime
* over zenith and (optionally) azimuth angles
*
* @param[in] dir Sky direction.
* @param[in] energy Energy.
* @param[in] aeff Effective area.
*
* Computes
* \f[\sum_{\cos \theta, \phi} T_{\rm corr.~live}(\cos \theta, \phi)
* A_{\rm eff}(\cos \theta, \phi)\f]
* where
* \f$T_{\rm corr.~live}(\cos \theta, \phi)\f$ is the efficiency corrected
* livetime as a function of the cosine of the zenith and of the azimuth
* angle, and
* \f$A_{\rm eff}(\cos \theta, \phi)\f$ is the effective area that depends
* on the cosine of the zenith angle and (optionally) of the azimuth angle.
***************************************************************************/
double GLATLtCube::operator()(const GSkyDir& dir, const GEnergy& energy,
const GLATAeff& aeff) const
{
// Compute exposure
double exposure = m_exposure(dir, energy, aeff);
// Optionally compute livetime factors for trigger rate- and
// energy-dependent efficiency corrections
if (aeff.has_efficiency()) {
// Compute correction factors
double f1 = aeff.efficiency_factor1(energy);
double f2 = aeff.efficiency_factor2(energy);
// Compute correction
double correction = m_weighted_exposure(dir, energy, aeff);
// Set exposure
exposure = f1 * exposure + f2 * correction;
} // endif: corrections requested
// Return exposure
return exposure;
}
/***********************************************************************//**
* @brief Sum point spread function multiplied by efficiency corrected
* livetime over zenith angles
*
* @param[in] dir Sky direction.
* @param[in] energy Energy.
* @param[in] offset Offset from true direction (deg).
* @param[in] psf Point spread function.
* @param[in] aeff Effective area.
*
* Computes
* \f[\sum_{\cos \theta, \phi} T_{\rm corr.~live}(\cos \theta, \phi)
* PSF(\log E, \delta, \cos \theta) A_{\rm eff}(\cos \theta, \phi)\f]
* where
* \f$T_{\rm corr.~live}(\cos \theta, \phi)\f$ is the efficiency corrected
* livetime as a function of the cosine of the zenith and of the azimuth
* angle,
* \f$PSF(\log E, \delta, \cos \theta)\f$ is the point spread function that
* depends on
* the log10 of the energy (in MeV),
* the offset angle from the true direction (in degrees), and
* the cosine of the zenith angle, and
* \f$A_{\rm eff}(\cos \theta, \phi)\f$ is the effective area that depends
* on the cosine of the zenith angle and (optionally) of the azimuth angle.
***************************************************************************/
double GLATLtCube::operator()(const GSkyDir& dir, const GEnergy& energy,
const double& offset, const GLATPsf& psf,
const GLATAeff& aeff) const
{
// Compute exposure
double exposure = m_exposure(dir, energy, offset, psf, aeff);
// Optionally compute livetime factors for trigger rate- and
// energy-dependent efficiency corrections
if (aeff.has_efficiency()) {
// Compute correction factors
double f1 = aeff.efficiency_factor1(energy);
double f2 = aeff.efficiency_factor2(energy);
// Compute correction
double correction = m_weighted_exposure(dir, energy, offset, psf, aeff);
// Set exposure
exposure = f1 * exposure + f2 * correction;
} // endif: corrections requested
// Return exposure
return exposure;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear lifetime cube
***************************************************************************/
void GLATLtCube::clear(void)
{
// Free class members
free_members();
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Clone lifetime cube
*
* @return Pointer to deep copy of lifetime cube.
***************************************************************************/
GLATLtCube* GLATLtCube::clone(void) const
{
return new GLATLtCube(*this);
}
/***********************************************************************//**
* @brief Load livetime cube from FITS file
*
* @param[in] filename FITS file name.
*
* @todo Loading of cos theta boundaries not yet implemented. This is not
* critical since they are not really needed. We just need them once
* we want to implement also saving.
***************************************************************************/
void GLATLtCube::load(const std::string& filename)
{
// Clear object
clear();
// Open lifetime cube FITS file
GFits file(filename);
// Get HDUs
const GFitsTable& hdu_exposure = *file.table("EXPOSURE");
const GFitsTable& hdu_weighted_exposure = *file.table("WEIGHTED_EXPOSURE");
//const GFitsTable& hdu_cthetabounds = *file.table("CTHETABOUNDS");
const GFitsTable& hdu_gti = *file.table("GTI");
// Load exposure
m_exposure.read(hdu_exposure);
// Load weighted exposure
m_weighted_exposure.read(hdu_weighted_exposure);
// Load cos theta boundaries
// Load GTIs
m_gti.read(hdu_gti);
// Close FITS file
file.close();
// Return
return;
}
/***********************************************************************//**
* @brief Save livetime cube into FITS file
*
* @param[in] filename FITS file name.
* @param[in] clobber Overwrite existing file?
*
* @todo Not yet implemented.
***************************************************************************/
void GLATLtCube::save(const std::string& filename, const bool& clobber) const
{
// Return
return;
}
/***********************************************************************//**
* @brief Print livetime cube information
*
* @param[in] chatter Chattiness (defaults to NORMAL).
* @return String containing livetime cube information.
***************************************************************************/
std::string GLATLtCube::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("=== GLATLtCube ===");
// Append detailed information
GChatter reduced_chatter = gammalib::reduce(chatter);
if (reduced_chatter > SILENT) {
result.append("\n"+m_exposure.print(reduced_chatter));
result.append("\n"+m_weighted_exposure.print(reduced_chatter));
result.append("\n"+m_gti.print(reduced_chatter));
}
} // endif: chatter was not silent
// Return result
return result;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GLATLtCube::init_members(void)
{
// Initialise members
m_exposure.clear();
m_weighted_exposure.clear();
m_gti.clear();
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] cube Livetime cube.
***************************************************************************/
void GLATLtCube::copy_members(const GLATLtCube& cube)
{
// Copy members
m_exposure = cube.m_exposure;
m_weighted_exposure = cube.m_weighted_exposure;
m_gti = cube.m_gti;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GLATLtCube::free_members(void)
{
// Return
return;
}