GCOMStatus.cpp
14.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
/***************************************************************************
* GCOMStatus.cpp - COMPTEL instrument status class *
* ----------------------------------------------------------------------- *
* copyright (C) 2017 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 GCOMStatus.cpp
* @brief COMPTEL instrument status class implementation
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GTools.hpp"
#include "GException.hpp"
#include "GCaldb.hpp"
#include "GFits.hpp"
#include "GFitsTable.hpp"
#include "GCOMStatus.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_D1STATUS "GCOMStatus::d1status(int&, int&)"
#define G_D2STATUS "GCOMStatus::d2status(int&, int&)"
#define G_UPDATE_CACHE "GCOMStatus::update_cache(int&)"
#define G_LOAD_STATUS "GCOMStatus::load_status()"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GCOMStatus::GCOMStatus(void)
{
// Initialise class members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] status COMPTEL instrument status.
***************************************************************************/
GCOMStatus::GCOMStatus(const GCOMStatus& status)
{
// Initialise class members
init_members();
// Copy members
copy_members(status);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GCOMStatus::~GCOMStatus(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] status COMPTEL instrument status.
* @return COMPTEL instrument status.
***************************************************************************/
GCOMStatus& GCOMStatus::operator=(const GCOMStatus& status)
{
// Execute only if object is not identical
if (this != &status) {
// Free members
free_members();
// Initialise private members
init_members();
// Copy members
copy_members(status);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear COMPTEL instrument status
***************************************************************************/
void GCOMStatus::clear(void)
{
// Free members
free_members();
// Initialise private members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Clone COMPTEL instrument status
*
* @return Pointer to deep copy of COMPTEL instrument status.
***************************************************************************/
GCOMStatus* GCOMStatus::clone(void) const
{
return new GCOMStatus(*this);
}
/***********************************************************************//**
* @brief Load COMPTEL instrument status database
***************************************************************************/
void GCOMStatus::load(void) const
{
// Load database
load_status();
// Return
return;
}
/***********************************************************************//**
* @brief Return D1 module status
*
* @param[in] tjd TJD for status inquiry.
* @param[in] module D1 module number (1-7).
* @return D1 module status.
***************************************************************************/
int GCOMStatus::d1status(const int& tjd, const int& module) const
{
// Load database if it's not yet available
if (m_tjds.empty()) {
load_status();
}
// Check that module number is in range
if (module < 1 || module > 7) {
std::string msg = "Invalid D1 module number ("+gammalib::str(module)+
"). Number needs to be comprised within [1,7].";
throw GException::invalid_argument(G_D1STATUS, msg);
}
// Update cache
update_cache(tjd);
// Return module status
return (m_last_d1status[module-1]);
}
/***********************************************************************//**
* @brief Return D2 module status
*
* @param[in] tjd TJD for status inquiry.
* @param[in] module D2 module number (1-14).
* @return D2 module status.
***************************************************************************/
int GCOMStatus::d2status(const int& tjd, const int& module) const
{
// Load database if it's not yet available
if (m_tjds.empty()) {
load_status();
}
// Check that module number is in range
if (module < 1 || module > 14) {
std::string msg = "Invalid D2 module number ("+gammalib::str(module)+
"). Number needs to be comprised within [1,14].";
throw GException::invalid_argument(G_D2STATUS, msg);
}
// Update cache
update_cache(tjd);
// Return module status
return (m_last_d2status[module-1]);
}
/***********************************************************************//**
* @brief Print COMPTEL instrument status
*
* @param[in] chatter Chattiness.
* @return String containing COMPTEL instrument status information.
***************************************************************************/
std::string GCOMStatus::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("=== GCOMStatus ===");
// Append information
result.append("\n"+gammalib::parformat("Database"));
if (m_tjds.empty()) {
result.append("not loaded");
}
else {
result.append("loaded");
result.append("\n"+gammalib::parformat("Number of entries"));
result.append(gammalib::str(m_tjds.size()));
result.append("\n"+gammalib::parformat("TJD range"));
result.append(gammalib::str(m_tjds[0]));
result.append(" - ");
result.append(gammalib::str(m_tjds[m_tjds.size()-1]));
result.append(" days");
}
} // endif: chatter was not silent
// Return result
return result;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GCOMStatus::init_members(void)
{
// Initialise members
m_tjds.clear();
m_d1status.clear();
m_d2status.clear();
// Initialise cache
m_last_tjd = 0;
m_last_d1status.clear();
m_last_d2status.clear();
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] status COMPTEL instrument status.
***************************************************************************/
void GCOMStatus::copy_members(const GCOMStatus& status)
{
// Copy members
m_tjds = status.m_tjds;
m_d1status = status.m_d1status;
m_d2status = status.m_d2status;
// Copy cache
m_last_tjd = status.m_last_tjd;
m_last_d1status = status.m_last_d1status;
m_last_d2status = status.m_last_d2status;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GCOMStatus::free_members(void)
{
// Return
return;
}
/***********************************************************************//**
* @brief Update module status cache
*
* @param[in] tjd TJD for status inquiry.
***************************************************************************/
void GCOMStatus::update_cache(const int& tjd) const
{
// Update cache only if the TJD value has changed
if (tjd != m_last_tjd) {
// Update TJD value
m_last_tjd = tjd;
// Signal that cache update was successful
bool success = false;
// Find index
for (int i = 0; i < m_tjds.size(); ++i) {
if (m_tjds[i] == tjd) {
m_last_d1status = m_d1status[i];
m_last_d2status = m_d2status[i];
success = true;
break;
}
}
// Throw an exception if update was not successful
if (!success) {
std::string msg = "No COMPTEL status information found for TJD "+
gammalib::str(tjd)+" in module status database. "
"Please exclude that day from your analysis.";
throw GException::invalid_value(G_UPDATE_CACHE, msg);
}
} // endif: TJD value has changed
// Return
return;
}
/***********************************************************************//**
* @brief Load status information from database
*
* Loads the status information from the database.
***************************************************************************/
void GCOMStatus::load_status(void) const
{
// Initialise status vectors
m_tjds.clear();
m_d1status.clear();
m_d2status.clear();
// Locate COMPTEL calibration database that hold the module status
// information
GCaldb caldb("cgro","comptel");
// Get database filename
GFilename filename = caldb.filename("","","MODULE_STATUS","","","DEFAULT");
// If filename is empty then throw an exception
if (filename.is_empty()) {
std::string msg = "COMPTEL status information not found in COMPTEL "
"calibration database. Make sure that the COMPTEL "
"calibration database is in the path of the $CALDB "
"environment variable.";
throw GException::invalid_value(G_LOAD_STATUS, msg);
}
// Open FITS file
GFits fits(filename);
// Get status table
const GFitsTable& table = *fits.table(1);
// Extract number of entries in table
int num = table.nrows();
// If there are entries then read them
if (num > 0) {
// Get column pointers
const GFitsTableCol* ptr_tjd = table["TJD"];
const GFitsTableCol* ptr_d1status = table["D1STATUS"];
const GFitsTableCol* ptr_d2status = table["D2STATUS"];
// Reserve space
m_tjds.reserve(num);
m_d1status.reserve(num);
m_d2status.reserve(num);
// Copy data from table into vectors
for (int i = 0; i < num; ++i) {
// Copy TJD
m_tjds.push_back(ptr_tjd->integer(i));
// Copy D1 status
std::vector<int> d1status;
for (int k = 0; k < 7; ++k) {
d1status.push_back(ptr_d1status->integer(i,k));
}
m_d1status.push_back(d1status);
// Copy D2 status
std::vector<int> d2status;
for (int k = 0; k < 14; ++k) {
d2status.push_back(ptr_d2status->integer(i,k));
}
m_d2status.push_back(d2status);
} // endfor: looped over entries
} // endif: there were entries
// Close FITS file
fits.close();
// Return
return;
}