test_ctbin.py
14 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
#! /usr/bin/env python
# ==========================================================================
# This scripts performs unit tests for the ctbin tool.
#
# Copyright (C) 2014-2018 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/>.
#
# ==========================================================================
import os
import gammalib
import ctools
from testing import test
# ========================= #
# Test class for ctbin tool #
# ========================= #
class Test(test):
"""
Test class for ctbin tool
This test class makes unit tests for the ctbin tool by using it from
the command line and from Python.
"""
# Constructor
def __init__(self):
"""
Constructor
"""
# Call base class constructor
test.__init__(self)
# Set members
self._inobs_two = self._datadir + '/obs_unbinned_two.xml'
# Return
return
# Set test functions
def set(self):
"""
Set all test functions
"""
# Set test name
self.name('ctbin')
# Append tests
self.append(self._test_cmd, 'Test ctbin on command line')
self.append(self._test_python, 'Test ctbin from Python')
# Return
return
# Test ctbin on command line
def _test_cmd(self):
"""
Test ctbin on the command line
"""
# Set tool name
ctbin = self._tool('ctbin')
# Setup ctbin command
cmd = ctbin+' inobs="'+self._events+'"'+ \
' outobs="cntmap_cmd1.fits"'+\
' emin=1.0 emax=100.0 enumbins=10 ebinalg="LOG"'+ \
' nxpix=40 nypix=40 binsz=0.1 coordsys="CEL"'+ \
' xref=83.63 yref=22.01 proj="CAR"'+ \
' logfile="ctbin_cmd1.log" chatter=1'
# Check if execution was successful
self.test_value(self._execute(cmd), 0,
'Check successful execution from command line')
# Load counts cube and check content.
evt = gammalib.GCTAEventCube('cntmap_cmd1.fits')
self._check_cube(evt, 245)
# Setup ctbin command
cmd = ctbin+' inobs="events_that_do_not_exist.fits"'+ \
' outobs="cntmap_cmd2.fits"'+\
' emin=1.0 emax=100.0 enumbins=10 ebinalg="LOG"'+ \
' nxpix=40 nypix=40 binsz=0.1 coordsys="CEL"'+ \
' xref=83.63 yref=22.01 proj="CAR"'+ \
' logfile="ctbin_cmd2.log" debug=yes chatter=1'
# Check if execution failed
self.test_assert(self._execute(cmd, success=False) != 0,
'Check invalid input file when executed from command line')
# Setup ctbin command with different ebounds than input
cmd = ctbin+' inobs="'+self._events+'"'+ \
' outobs="cntmap_cmd3.fits"'+\
' emin=2.0 emax=20.0 enumbins=10 ebinalg="LOG"'+ \
' nxpix=40 nypix=40 binsz=0.1 coordsys="CEL"'+ \
' xref=83.63 yref=22.01 proj="CAR"'+ \
' logfile="ctbin_cmd3.log" chatter=3'
# Check if execution was successful
self.test_value(self._execute(cmd), 0,
'Check successful execution from command line')
# Load counts cube and check content.
evt = gammalib.GCTAEventCube('cntmap_cmd3.fits')
self._check_cube(evt, 115)
# Check joint (unstacked) binning
# Setup ctbin command
cmd = ctbin+' inobs="'+self._inobs_two+'"'+ \
' outobs="obs_unbinned_two_binned.xml"'+\
' emin=1.0 emax=100.0 enumbins=10 ebinalg="LOG"'+ \
' nxpix=40 nypix=40 binsz=0.1 coordsys="CEL"'+ \
' xref=83.63 yref=22.01 proj="CAR"'+ \
' logfile="ctbin_cmd4.log" chatter=1 stack=no'+ \
' prefix="cntmap_cmd4_"'
# Check if execution was successful
self.test_value(self._execute(cmd), 0,
'Check successful execution from command line with stack=no')
# Load counts cubes and check content.
evt = gammalib.GCTAEventCube('cntmap_cmd4_cta_00001.fits')
self._check_cube(evt, 245)
# Load counts cubes and check content.
evt = gammalib.GCTAEventCube('cntmap_cmd4_cta_00002.fits')
self._check_cube(evt, 245)
# Check observation definition XML output file
obs = gammalib.GObservations('obs_unbinned_two_binned.xml')
self.test_value(obs.size(), 2, 'Check for 2 observations in XML file')
# Check for content of observations file
self.test_value(obs[0].eventfile().file(), 'cntmap_cmd4_cta_00001.fits',
'Check first counts cube file name')
self.test_value(obs[1].eventfile().file(), 'cntmap_cmd4_cta_00002.fits',
'Check second counts cube file name')
# Check ctbin --help
self._check_help(ctbin)
# Return
return
# Test ctbin from Python
def _test_python(self):
"""
Test ctbin from Python
"""
# Allocate ctbin
binning = ctools.ctbin()
# Check that empty ctbin has an empty observation container and counts
# cube
self.test_value(binning.obs().size(), 0,
'Check that empty ctbin has an empty observation container')
self.test_value(binning.cubes(), 0,
'Check that empty ctbin has an empty counts cube')
# Check that saving does not nothing
binning['logfile'] = 'ctbin_py0.log'
binning['outobs'] = 'ctbin_py0.fits'
binning.logFileOpen()
binning.save()
self.test_assert(not os.path.isfile('ctbin_py0.fits'),
'Check that no counts cube has been created')
# Check that publishing does not lead to an exception or segfault
binning.publish()
# Check that clearing does not lead to an exception or segfault
binning.clear()
# Now set ctbin parameters
binning['inobs'] = self._events
binning['outobs'] = 'ctbin_py1.fits'
binning['ebinalg'] = 'LOG'
binning['emin'] = 1.0
binning['emax'] = 100.0
binning['enumbins'] = 10
binning['nxpix'] = 40
binning['nypix'] = 40
binning['binsz'] = 0.1
binning['coordsys'] = 'CEL'
binning['proj'] = 'CAR'
binning['xref'] = 83.63
binning['yref'] = 22.01
binning['logfile'] = 'ctbin_py1.log'
binning['chatter'] = 2
# Run ctbin tool
binning.logFileOpen()
binning.run()
# Check content of observation container and counts cube
self._check_observation(binning, 245)
self._check_cube(binning.cube(), 245)
# Copy ctbin tool
cpy_bin = binning.copy()
# Check content of observation container and counts cube
self._check_observation(cpy_bin, 245)
self._check_cube(cpy_bin.cube(), 245)
# Run copy of ctbin tool again
cpy_bin['logfile'] = 'ctbin_py2.log'
cpy_bin['chatter'] = 3
cpy_bin.logFileOpen()
cpy_bin.run()
# Check content of observation container and number of counts cubes.
# There should be a single binned observation in the observation
# container, which is the one that was produced in the run before.
# Since ctbin finds no unbinned observation in the container, the
# number of cubes should be zero.
self._check_observation(cpy_bin, 245)
self.test_value(cpy_bin.cubes(), 0, 'Check that there are no counts cubes')
# Save counts cube
binning.save()
# Load counts cube and check content
evt = gammalib.GCTAEventCube('ctbin_py1.fits')
self._check_cube(evt, 245)
# Now clear ctbin tool
binning.clear()
# Check that cleared ctbin has an empty observation container and
# counts cube
self.test_value(binning.obs().size(), 0,
'Check that empty ctbin has an empty observation container')
self.test_value(binning.cubes(), 0,
'Check that empty ctbin has an empty counts cube')
# Prepare observation container for stacking of events into a
# single counts cube
obs = self._obs_events()
# Set-up ctbin using an observation container
binning = ctools.ctbin(obs)
binning['outobs'] = 'ctbin_py3.fits'
binning['ebinalg'] = 'LOG'
binning['emin'] = 1.0
binning['emax'] = 100.0
binning['enumbins'] = 10
binning['nxpix'] = 40
binning['nypix'] = 40
binning['binsz'] = 0.1
binning['coordsys'] = 'CEL'
binning['proj'] = 'CAR'
binning['xref'] = 83.63
binning['yref'] = 22.01
binning['publish'] = True
binning['logfile'] = 'ctbin_py3.log'
binning['chatter'] = 3
# Execute ctbin tool
binning.logFileOpen()
binning.execute()
# Check content of observation and cube (need multiplier=3 since
# three identical observations have been appended)
self._check_observation(binning, 245, multiplier=3)
self._check_cube(binning.cube(), 245, multiplier=3)
# Load counts cube and check content.
evt = gammalib.GCTAEventCube('ctbin_py3.fits')
self._check_cube(evt, 245, multiplier=3)
# Now go for a fully Pythonic version with all parameters being
# specified in a dictionary
pars = {'inobs': self._events, 'ebinalg': 'LIN', 'emin': 1.0,
'emax': 100.0, 'enumbins': 10, 'nxpix': 40, 'nypix': 40,
'binsz': 0.1, 'coordsys': 'CEL', 'proj': 'CAR',
'xref': 83.63, 'yref': 22.01, 'outobs': 'ctbin_py4.fits',
'logfile': 'ctbin_py4.log', 'chatter': 2}
binning = ctools.ctbin()
binning.pardict(pars)
binning.logFileOpen()
binning.execute()
# Load counts cube and check content
evt = gammalib.GCTAEventCube('ctbin_py4.fits')
self._check_cube(evt, 245)
# Test unstacked version
binning = ctools.ctbin()
binning['inobs'] = self._inobs_two
binning['stack'] = False
binning['prefix'] = 'cntcube_py5_'
binning['ebinalg'] = 'LOG'
binning['emin'] = 1.0
binning['emax'] = 100.0
binning['enumbins'] = 10
binning['nxpix'] = 40
binning['nypix'] = 40
binning['binsz'] = 0.1
binning['coordsys'] = 'CEL'
binning['proj'] = 'CAR'
binning['xref'] = 83.63
binning['yref'] = 22.01
binning['outobs'] = 'ctbin_py5.xml'
binning['logfile'] = 'ctbin_py5.log'
binning['chatter'] = 2
binning.logFileOpen()
binning.run()
# Check individual cubes
self._check_cube(binning.cube(0), 245)
self._check_cube(binning.cube(1), 245)
# Save counts cube
binning.save()
# Load observations
obs = gammalib.GObservations('ctbin_py5.xml')
self.test_value(obs.size(), 2, 'Check number of output observations')
# Check counts cubes
evt = obs[0].events()
self._check_cube(evt, 245)
evt = obs[1].events()
self._check_cube(evt, 245)
# Load counts cubes and check content
evt = gammalib.GCTAEventCube('cntcube_py5_cta_00001.fits')
self._check_cube(evt, 245)
evt = gammalib.GCTAEventCube('cntcube_py5_cta_00002.fits')
self._check_cube(evt, 245)
# Return
return
# Check observation
def _check_observation(self, ctbin, nevents, multiplier=1):
"""
Check content of an observation
Parameters
----------
ctbin : `~ctools.ctbin`
ctbin instance
nevents : int
Expected number of events
multiplier : float, optional
Ontime and livetime multiplier
"""
# Test observation container
obs = gammalib.GCTAObservation(ctbin.obs()[0])
pnt = obs.pointing()
self.test_value(ctbin.obs().size(), 1,
'Check that there is one observation on the observation container')
self.test_value(obs.instrument(), 'CTA',
'Check that the one observation is a CTA observation')
self.test_value(obs.ontime(), 300.0*multiplier, 1.0e-6,
'Check ontime of observation')
self.test_value(obs.livetime(), 294.0*multiplier, 1.0e-6,
'Check livetime of observation')
self.test_value(pnt.dir().ra_deg(), 83.63, 1.0e-6,
'Check pointing Right Ascension of observation')
self.test_value(pnt.dir().dec_deg(), 22.51, 1.0e-6,
'Check pointing Declination of observation')
# Test event cube
self._check_cube(obs.events(), nevents, multiplier=multiplier)
# Return
return
# Check event cube
def _check_cube(self, cube, nevents, multiplier=1):
"""
Check content of event cube
Parameters
----------
cube : `~gammalib.GCTAEventCube`
Event cube
nevents : int
Expected number of events
multiplier : float
Event number multiplier
"""
# Test event cube
self.test_value(cube.size(), 16000,
'Check bin size of counts cube')
self.test_value(cube.number(), nevents*multiplier,
'Check number of events in counts cube')
# Return
return