ctselect.cpp
12.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
/***************************************************************************
* ctselect - CTA data selection tool *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2011 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. *
* *
***************************************************************************/
/**
* @file ctselect.cpp
* @brief CTA data selection tool implementation
* @author J. Knodlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <stdio.h>
#include "ctselect.hpp"
#include "GTools.hpp"
/* __ Debug definitions __________________________________________________ */
#define BIT_COLUMN_TEST 0
#define STRING_COLUMN_TEST 1
/* __ Coding definitions _________________________________________________ */
#define SELECT_TIME 1
#define SELECT_ENERGY 1
#define SELECT_ROI 1
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
ctselect::ctselect(void) : GApplication(CTSELECT_NAME, CTSELECT_VERSION)
{
// Initialise members
init_members();
// Write header into logger
log_header();
// Return
return;
}
/***********************************************************************//**
* @brief Command line constructor
*
* @param[in] argc Number of arguments in command line.
* @param[in] argv Array of command line arguments.
***************************************************************************/
ctselect::ctselect(int argc, char *argv[]) :
GApplication(CTSELECT_NAME, CTSELECT_VERSION, argc, argv)
{
// Initialise members
init_members();
// Write header into logger
log_header();
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
ctselect::~ctselect(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Select event data
*
* A GTI is appended to the FITS file as in the actual data format no GTI
* exists.
***************************************************************************/
void ctselect::run(void)
{
// Switch screen logging on in debug mode
if (logDebug())
log.cout(true);
// Get parameters
get_parameters();
// Write parameters into logger
if (logTerse()) {
log_parameters();
log << std::endl;
}
// Select events
select();
// Append GTI to FITS file
append_gti();
// Set data selection keywords
write_ds_keys();
// Save output FITS file
m_file.saveto(m_outfile, clobber());
// Close FITS file
m_file.close();
// Write separator into logger
if (logTerse())
log << std::endl;
// Return
return;
}
/***********************************************************************//**
* @brief Get application parameters
*
* Get all task parameters from parameter file or (if required) by querying
* the user.
***************************************************************************/
void ctselect::get_parameters(void)
{
// Get parameters
m_infile = par("infile")->value();
m_outfile = par("outfile")->value();
m_ra = par("ra")->real();
m_dec = par("dec")->real();
m_rad = par("rad")->real();
m_tmin = par("tmin")->real();
m_tmax = par("tmax")->real();
m_emin = par("emin")->real();
m_emax = par("emax")->real();
// Return
return;
}
/***********************************************************************//**
* @brief Select events
*
* Select events from a FITS file by making use of the selection possibility
* of the cfitsio library on loading a file into memory. Event selection is
* kept optional (on compile time) as the data format may still evolve (for
* the time being the TIME information is not valid).
*
* @todo Set data selection keywords.
***************************************************************************/
void ctselect::select(void)
{
// Write Header for event selection
if (logTerse()) {
log << std::endl;
log.header1("Event selection");
}
// Build selection string
std::string selection;
#if SELECT_TIME
selection = "TIME >= "+str(m_tmin)+" && TIME <= "+str(m_tmax);
if (logTerse())
log << " Time range ................: " << m_tmin << "-" << m_tmax
<< std::endl;
#endif
#if SELECT_ENERGY
if (selection.length() > 0)
selection += " && ";
selection += "ENERGY >= "+str(m_emin)+" && ENERGY <= "+str(m_emax);
if (logTerse())
log << " Energy range ..............: " << m_emin << "-" << m_emax
<< " TeV" << std::endl;
#endif
#if SELECT_ROI
if (selection.length() > 0)
selection += " && ";
selection += "ANGSEP("+str(m_ra)+","+str(m_dec)+",RA,DEC) <= "+str(m_rad);
if (logTerse()) {
log << " Acceptance cone centre ....: RA=" << m_ra << ", DEC=" << m_dec
<< " deg" << std::endl;
log << " Acceptance cone radius ....: " << m_rad << " deg" << std::endl;
}
#endif
if (logTerse())
log << " cfitsio selection .........: " << selection << std::endl;
// Build input filename including selection expression
std::string expression = m_infile;
if (selection.length() > 0)
expression += "[EVENTS]["+selection+"]";
if (logTerse())
log << " FITS filename .............: " << expression << std::endl;
// Open FITS file
m_file.open(expression);
// Log selected FITS file
if (logExplicit()) {
log << std::endl;
log.header1("FITS file content after selection");
log << m_file << std::endl;
}
// Return
return;
}
/***********************************************************************//**
* @brief Append GTI to FITS file
*
* @todo We implement here a dummy method that overwrites an existing GTI
* entry but that only works if a single time interval exists. This
* is not clean, but since we have no method so far that allows
* deleting a HDU from a FITS file we have no other choice. Ideally,
* we would like to first delete an existing HDU and then append
* a new one. If this is not possible, we would like to delete the
* rows from an existing GTI and then fill it up anew. But in any
* case, the actual data selection method does not check the
* existing GTI, which we have to do to merge any subselection
* information in. In fact, we need a GTI merge method as well ...
***************************************************************************/
void ctselect::append_gti(void)
{
// Setup selected time range
GTime tstart;
GTime tstop;
tstart.met(m_tmin);
tstop.met(m_tmax);
// Initialise empty GTI table HDU
GFitsTable* hdu = NULL;
// Write selected time interval, either in an existing GTI or in a new
// GTI that is appended to the FITS file
try {
hdu = m_file.table("GTI");
GFitsTableDoubleCol* start = (GFitsTableDoubleCol*)hdu->column("START");
GFitsTableDoubleCol* stop = (GFitsTableDoubleCol*)hdu->column("STOP");
(*start)(0) = tstart.met();
(*stop)(0) = tstop.met();
}
catch (GException::fits_hdu_not_found) {
// Allocate Gti
GGti gti;
// Setup single GTI covering the selected time range
gti.add(tstart, tstop);
// Write GTI
gti.write(&m_file);
}
// Log final FITS file
if (logExplicit()) {
log << std::endl;
log.header1("Final FITS file content");
log << m_file << std::endl;
}
// Return
return;
}
/***********************************************************************//**
* @brief Write data selection keywords
*
* @todo This is a very dumb data selection keyword writing routine that does
* not take into account any existing keywords. We definitely want a
* more secure logic that checks for existing keywords and possible
* conflicts. But for this prototype software, this code does the job.
***************************************************************************/
void ctselect::write_ds_keys(void)
{
// Get event list header
GFitsHDU* hdu = m_file.hdu("EVENTS");
// Continue only if HDU is valid
if (hdu != NULL) {
// Set cone selection string
std::string dsval2 = "CIRCLE("+str(m_ra)+","+str(m_dec)+","+str(m_rad)+")";
// Set energy selection string
std::string dsval3 = str(m_emin)+":"+str(m_emax);
// Add time selection keywords
hdu->card("DSTYP1", "TIME", "Data selection type");
hdu->card("DSUNI1", "s", "Data selection unit");
hdu->card("DSVAL1", "TABLE", "Data selection value");
hdu->card("DSREF1", ":GTI", "Data selection reference");
// Add acceptance cone selection
hdu->card("DSTYP2", "POS(RA,DEC)", "Data selection type");
hdu->card("DSUNI2", "deg", "Data selection unit");
hdu->card("DSVAL2", dsval2, "Data selection value");
// Add energy range selection
hdu->card("DSTYP3", "ENERGY", "Data selection type");
hdu->card("DSUNI3", "TeV", "Data selection unit");
hdu->card("DSVAL3", dsval3, "Data selection value");
// Set number of data selection keys
hdu->card("NDSKEYS", 3, "Number of data selections");
} // endif: HDU was valid
// Return
return;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void ctselect::init_members(void)
{
// Initialise members
m_infile.clear();
m_outfile.clear();
m_ra = 0.0;
m_dec = 0.0;
m_rad = 0.0;
m_tmin = 0.0;
m_tmax = 0.0;
m_emin = 0.0;
m_emax = 0.0;
// Set logger properties
log.date(true);
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void ctselect::free_members(void)
{
// Free members
// Return
return;
}