GCOMObservation.hpp
11 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
/***************************************************************************
* GCOMObservation.hpp - COMPTEL observation class *
* ----------------------------------------------------------------------- *
* copyright (C) 2012-2016 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 GCOMObservation.hpp
* @brief COMPTEL observation class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GCOMOBSERVATION_HPP
#define GCOMOBSERVATION_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GObservation.hpp"
#include "GTime.hpp"
#include "GFilename.hpp"
#include "GSkyDir.hpp"
#include "GSkyMap.hpp"
#include "GCOMResponse.hpp"
//#include "GCaldb.hpp"
/* __ Forward declarations _______________________________________________ */
class GCaldb;
class GResponse;
class GXmlElement;
class GFitsHDU;
/***********************************************************************//**
* @class GCOMObservation
*
* @brief Interface class for COMPTEL observations
*
* This class implements a COMPTEL observation. Each COMPTEL observation is
* defined for a given energy range, and is composed of a DRE, DRB, DRG and
* DRX file. The DRE file contains the event data, the DRB file contains a
* background model, the DRG file contains geometry factors, and the DRX file
* contains the exposure.
***************************************************************************/
class GCOMObservation : public GObservation {
public:
// Constructors and destructors
GCOMObservation(void);
GCOMObservation(const GFilename& drename,
const GFilename& drbname,
const GFilename& drgname,
const GFilename& drxname);
GCOMObservation(const GCOMObservation& obs);
virtual ~GCOMObservation(void);
// Operators
virtual GCOMObservation& operator=(const GCOMObservation& obs);
// Implement pure virtual methods
virtual void clear(void);
virtual GCOMObservation* clone(void) const;
virtual std::string classname(void) const;
virtual void response(const GResponse& rsp);
virtual const GCOMResponse* response(void) const;
virtual std::string instrument(void) const;
virtual double ontime(void) const;
virtual double livetime(void) const;
virtual double deadc(const GTime& time = GTime()) const;
virtual void read(const GXmlElement& xml);
virtual void write(GXmlElement& xml) const;
virtual std::string print(const GChatter& chatter = NORMAL) const;
// Other methods
void load(const GFilename& drename,
const GFilename& drbname,
const GFilename& drgname,
const GFilename& drxname);
void response(const std::string& rspname, const GCaldb& caldb);
void obs_id(const double& id);
void ontime(const double& ontime);
void livetime(const double& livetime);
void deadc(const double& deadc);
void ewidth(const double& ewidth);
const double& obs_id(void) const;
const double& ewidth(void) const;
const GSkyMap& drb(void) const;
const GSkyMap& drg(void) const;
const GSkyMap& drx(void) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GCOMObservation& obs);
void free_members(void);
void load_dre(const GFilename& drename);
void load_drb(const GFilename& drbname);
void load_drg(const GFilename& drgname);
void load_drx(const GFilename& drxname);
bool check_map(const GSkyMap& map) const;
void read_attributes(const GFitsHDU* hdu);
void write_attributes(GFitsHDU* hdu) const;
// Protected members
std::string m_instrument; //!< Instrument name
GFilename m_drename; //!< DRE filename
GFilename m_drbname; //!< DRB filename
GFilename m_drgname; //!< DRG filename
GFilename m_drxname; //!< DRX filename
GSkyMap m_drb; //!< Background model
GSkyMap m_drg; //!< Geometry factors
GSkyMap m_drx; //!< Exposure map
GSkyDir m_pointing; //!< Pointing direction
GCOMResponse m_response; //!< Response functions
double m_obs_id; //!< Observation ID
double m_ontime; //!< Ontime (sec)
double m_livetime; //!< Livetime (sec)
double m_deadc; //!< Deadtime correction
double m_ewidth; //!< Energy width (MeV)
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GCOMObservation").
***************************************************************************/
inline
std::string GCOMObservation::classname(void) const
{
return ("GCOMObservation");
}
/***********************************************************************//**
* @brief Return response function
*
* @return Response function.
***************************************************************************/
inline
const GCOMResponse* GCOMObservation::response(void) const
{
// Return response pointer
return &m_response;
}
/***********************************************************************//**
* @brief Return instrument
*
* @return Instrument name.
***************************************************************************/
inline
std::string GCOMObservation::instrument(void) const
{
// Return instrument
return (m_instrument);
}
/***********************************************************************//**
* @brief Return ontime
*
* @return Ontime (seconds).
***************************************************************************/
inline
double GCOMObservation::ontime(void) const
{
// Return ontime
return (m_ontime);
}
/***********************************************************************//**
* @brief Return livetime
*
* @return Livetime (seconds).
***************************************************************************/
inline
double GCOMObservation::livetime(void) const
{
// Return livetime
return (m_livetime);
}
/***********************************************************************//**
* @brief Return deadtime correction factor
*
* @param[in] time Time.
*
* @return Deadtime correction factor.
***************************************************************************/
inline
double GCOMObservation::deadc(const GTime& time) const
{
// Return livetime
return (m_deadc);
}
/***********************************************************************//**
* @brief Set observation ID
*
* @param[in] id Observation ID.
***************************************************************************/
inline
void GCOMObservation::obs_id(const double& id)
{
m_obs_id = id;
return;
}
/***********************************************************************//**
* @brief Set ontime
*
* @param[in] ontime Ontime.
***************************************************************************/
inline
void GCOMObservation::ontime(const double& ontime)
{
m_ontime = ontime;
return;
}
/***********************************************************************//**
* @brief Set livetime
*
* @param[in] livetime Livetime.
***************************************************************************/
inline
void GCOMObservation::livetime(const double& livetime)
{
m_livetime = livetime;
return;
}
/***********************************************************************//**
* @brief Set deadtime correction factor
*
* @param[in] deadc Deadtime correction factor.
***************************************************************************/
inline
void GCOMObservation::deadc(const double& deadc)
{
m_deadc = deadc;
return;
}
/***********************************************************************//**
* @brief Set energy width
*
* @param[in] ewidth Energy width (MeV).
***************************************************************************/
inline
void GCOMObservation::ewidth(const double& ewidth)
{
m_ewidth = ewidth;
return;
}
/***********************************************************************//**
* @brief Return observation ID
*
* @return Observation ID.
***************************************************************************/
inline
const double& GCOMObservation::obs_id(void) const
{
// Return observation ID
return (m_obs_id);
}
/***********************************************************************//**
* @brief Return energy width
*
* @return Energy width (MeV).
***************************************************************************/
inline
const double& GCOMObservation::ewidth(void) const
{
// Return energy width
return (m_ewidth);
}
/***********************************************************************//**
* @brief Return background model
*
* @return Background model.
***************************************************************************/
inline
const GSkyMap& GCOMObservation::drb(void) const
{
// Return background model
return (m_drb);
}
/***********************************************************************//**
* @brief Return geometry factors
*
* @return Geometry factors.
***************************************************************************/
inline
const GSkyMap& GCOMObservation::drg(void) const
{
// Return geometry factors
return (m_drg);
}
/***********************************************************************//**
* @brief Return exposure
*
* @return Exposure.
***************************************************************************/
inline
const GSkyMap& GCOMObservation::drx(void) const
{
// Return exposure
return (m_drx);
}
#endif /* GCOMOBSERVATION_HPP */