GResponse.cpp
12.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
/***************************************************************************
* GResponse.cpp - Response abstract base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2008-2010 by Jurgen Knodlseder *
* ----------------------------------------------------------------------- *
* *
* 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 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <string>
#include <unistd.h> // access() function
#include "GResponse.hpp"
#include "GException.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_CALDB "GResponse::caldb(std::string&)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GResponse::GResponse(void)
{
// Initialise class members for clean destruction
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] rsp Response from which the instance should be built.
***************************************************************************/
GResponse::GResponse(const GResponse& rsp)
{
// Initialise class members for clean destruction
init_members();
// Copy members
copy_members(rsp);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GResponse::~GResponse(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] rsp Response which should be assigned.
***************************************************************************/
GResponse& GResponse::operator= (const GResponse& rsp)
{
// Execute only if object is not identical
if (this != &rsp) {
// Free members
free_members();
// Initialise private members for clean destruction
init_members();
// Copy members
copy_members(rsp);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Return value of point source 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 direction.
* @param[in] srcEng True energy of photon.
* @param[in] srcTime True photon arrival time.
* @param[in] pnt Instrument pointing information.
*
* This method implements the default and complete instrument response
* function (IRF). It may be overwritted by a specific method in the derived
* class that drops response terms that are not used.
***************************************************************************/
/*
double GResponse::irf(const GInstDir& obsDir, const GEnergy& obsEng,
const GTime& obsTime,
const GSkyDir& srcDir, const GEnergy& srcEng,
const GTime& srcTime, const GPointing& pnt) const
{
// Get point source IRF components
double irf = live(srcDir, srcEng, srcTime, pnt);
irf *= aeff(srcDir, srcEng, srcTime, pnt);
irf *= psf(obsDir, srcDir, srcEng, srcTime, pnt);
irf *= edisp(obsEng, srcDir, srcEng, srcTime, pnt);
irf *= tdisp(obsTime, srcDir, srcEng, srcTime, pnt);
// Return IRF value
return irf;
}
*/
/***********************************************************************//**
* @brief Return value of diffuse instrument response function.
*
* @param[in] event Observed event.
* @param[in] model Source model.
* @param[in] srcEng True energy of photon.
* @param[in] srcTime True photon arrival time.
* @param[in] pnt Instrument pointing information.
*
* This method implements the default and complete diffuse instrument
* response function (IRF). It may be overwritted by a specific method in the
* derived class that drops response terms that are not used.
*
* @todo Not yet implemented
***************************************************************************/
double GResponse::diffrsp(const GEvent& event, const GModel& model,
const GEnergy& srcEng, const GTime& srcTime,
const GPointing& pnt) const
{
// Get diffuse IRF components
double irf = 1.0;
// Return IRF value
return irf;
}
/***********************************************************************//**
* @brief Return integral of instrument response function.
*
* @param[in] srcDir True photon direction.
* @param[in] srcEng True energy of photon.
* @param[in] srcTime True photon arrival time.
* @param[in] pnt Instrument pointing information.
* @param[in] roi Region of interest of data selection.
* @param[in] ebds Energy boundaries of data selection.
* @param[in] gti Good Time Intervals of data selection.
*
* This method implements the default and complete integral of the instrument
* response function (IRF). It may be overwritted by a specific method in the
* derived class that drops response terms that are not used.
***************************************************************************/
/*
double GResponse::nirf(const GSkyDir& srcDir, const GEnergy& srcEng,
const GTime& srcTime, const GPointing& pnt,
const GRoi& roi, const GEbounds& ebds,
const GGti& gti) const
{
// Get IRF components
double nirf = live(srcDir, srcEng, srcTime, pnt);
nirf *= aeff(srcDir, srcEng, srcTime, pnt);
nirf *= npsf(srcDir, srcEng, srcTime, pnt, roi);
nirf *= nedisp(srcDir, srcEng, srcTime, pnt, ebds);
nirf *= ntdisp(srcDir, srcEng, srcTime, pnt, gti);
// Return integrated IRF value
return nirf;
}
*/
/***********************************************************************//**
* @brief Return energy dispersion integral for the case of no energy
* dispersion
*
* @param[in] srcDir True photon direction.
* @param[in] srcEng True energy of photon.
* @param[in] srcTime True photon arrival time.
* @param[in] pnt Instrument pointing information.
* @param[in] ebds Energy boundaries of data selection.
***************************************************************************/
/*
double GResponse::nedisp(const GSkyDir& srcDir, const GEnergy& srcEng,
const GTime& srcTime, const GPointing& pnt,
const GEbounds& ebds) const
{
// Assign result
double nedisp = (ebds.isin(srcEng)) ? 1.0 : 0.0;
// Return integral
return nedisp;
}
*/
/***********************************************************************//**
* @brief Return time dispersion integral for the case of no time dispersion
*
* @param[in] srcDir True photon direction.
* @param[in] srcEng True energy of photon.
* @param[in] srcTime True photon arrival time.
* @param[in] pnt Instrument pointing information.
* @param[in] gti Good Time Intervals of data selection.
***************************************************************************/
/*
double GResponse::ntdisp(const GSkyDir& srcDir, const GEnergy& srcEng,
const GTime& srcTime, const GPointing& pnt,
const GGti& gti) const
{
// Assign result
double ntdisp = (gti.isin(srcTime)) ? 1.0 : 0.0;
// Return integral
return ntdisp;
}
*/
/***********************************************************************//**
* @brief Set the path to the calibration database.
*
* @param[in] caldb Absolute path to calibration database
*
* This default method simply checks if the calibration database directory
* exists. If the directory exists, the path will be stored. No checking is
* implemented that checks for the consistency of the calibration database.
***************************************************************************/
void GResponse::caldb(const std::string& caldb)
{
// Check if calibration database directory is accessible
if (access(caldb.c_str(), R_OK) != 0)
throw GException::caldb_not_found(G_CALDB, caldb);
// Store the path to the calibration database
m_caldb = caldb;
// Return
return;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GResponse::init_members(void)
{
// Initialise members
m_caldb.clear();
m_rspname.clear();
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] rsp Response members which should be copied.
***************************************************************************/
void GResponse::copy_members(const GResponse& rsp)
{
// Copy attributes
m_caldb = rsp.m_caldb;
m_rspname = rsp.m_rspname;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GResponse::free_members(void)
{
// Return
return;
}
/*==========================================================================
= =
= Friends =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Output operator
*
* @param[in] os Output stream.
* @param[in] rsp Response.
***************************************************************************/
std::ostream& operator<< (std::ostream& os, const GResponse& rsp)
{
// Write response in output stream
os << rsp.print();
// Return output stream
return os;
}
/***********************************************************************//**
* @brief Log operator
*
* @param[in] log Logger.
* @param[in] rsp Response.
***************************************************************************/
GLog& operator<< (GLog& log, const GResponse& rsp)
{
// Write response into logger
log << rsp.print();
// Return logger
return log;
}