test_ctmodel.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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
#! /usr/bin/env python
# ==========================================================================
# This scripts performs unit tests for the ctmodel 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 ctmodel tool #
# =========================== #
class Test(test):
"""
Test class for ctmodel tool
"""
# Constructor
def __init__(self):
"""
Constructor
"""
# Call base class constructor
test.__init__(self)
# Set test data
self._obs_unbinned = self._datadir + '/obs_unbinned.xml'
self._expcube = self._datadir + '/crab_expcube.fits'
self._psfcube = self._datadir + '/crab_psfcube.fits'
self._edispcube = self._datadir + '/crab_edispcube.fits'
self._bkgcube = self._datadir + '/crab_bkgcube.fits'
self._bkgmodel = self._datadir + '/crab_bkgcube.xml'
# Return
return
# Set test functions
def set(self):
"""
Set all test functions
"""
# Set test name
self.name('ctmodel')
# Append tests
self.append(self._test_cmd, 'Test ctmodel on command line')
self.append(self._test_python, 'Test ctmodel from Python')
# Return
return
# Test ctmodel on command line
def _test_cmd(self):
"""
Test ctmodel on the command line
"""
# Set tool name
ctmodel = self._tool('ctmodel')
# Setup ctmodel command
cmd = ctmodel+' incube="NONE" inobs="NONE" expcube="NONE"'+\
' psfcube="NONE" bkgcube="NONE"'+ \
' outcube="ctmodel_cmd1.fits"'+ \
' inmodel="'+self._model+'"'+ \
' caldb="'+self._caldb+'" irf="'+self._irf+'"'+ \
' rad=5.0 ra=83.63 dec=22.01 tmin=0.0 tmax=1800'+ \
' emin=1.0 emax=100.0 enumbins=5 ebinalg="LOG"'+ \
' nxpix=40 nypix=40'+ \
' binsz=0.1 coordsys="CEL" proj="CAR"'+ \
' xref=83.63 yref=22.01'+ \
' logfile="ctmodel_cmd1.log" chatter=1'
# Check if execution was successful
self.test_assert(self._execute(cmd) == 0,
'Check successful execution from command line')
# Check result file
self._check_result_file('ctmodel_cmd1.fits')
# Setup ctmodel command
cmd = ctmodel+' incube="NONE" inobs="NONE" expcube="NONE"'+\
' psfcube="NONE" bkgcube="NONE"'+ \
' outcube="ctmodel_cmd2.fits"'+ \
' inmodel="model_that_does_not_exist.xml"'+ \
' caldb="'+self._caldb+'" irf="'+self._irf+'"'+ \
' rad=5.0 ra=83.63 dec=22.01 tmin=0.0 tmax=1800'+ \
' emin=1.0 emax=100.0 enumbins=5 ebinalg="LOG"'+ \
' nxpix=40 nypix=40'+ \
' binsz=0.1 coordsys="CEL" proj="CAR"'+ \
' xref=83.63 yref=22.01'+ \
' logfile="ctmodel_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')
# Check ctmodel --help
self._check_help(ctmodel)
# Return
return
# Test ctmodel from Python
def _test_python(self):
"""
Test ctmodel from Python
"""
# Allocate ctmodel
model = ctools.ctmodel()
# Check that empty ctmodel tool holds an empty model cube
self._check_cube(model.cube(), nx=0, ny=0, nebins=0)
# Check that saving does not nothing
model['outcube'] = 'ctmodel_py0.fits'
model['logfile'] = 'ctmodel_py0.log'
model.logFileOpen()
model.save()
self.test_assert(not os.path.isfile('ctmodel_py0.fits'),
'Check that no model cube has been created')
# Check that clearing does not lead to an exception or segfault
model.clear()
# Now set ctmodel parameters
model['incube'] = 'NONE'
model['inmodel'] = self._model
model['inobs'] = 'NONE'
model['expcube'] = 'NONE'
model['psfcube'] = 'NONE'
model['bkgcube'] = 'NONE'
model['caldb'] = self._caldb
model['irf'] = self._irf
model['rad'] = 5
model['ra'] = 83.63
model['dec'] = 22.01
model['tmin'] = 0
model['tmax'] = 1800
model['ebinalg'] = 'LOG'
model['emin'] = 1.0
model['emax'] = 100.0
model['enumbins'] = 5
model['nxpix'] = 40
model['nypix'] = 40
model['binsz'] = 0.1
model['coordsys'] = 'CEL'
model['proj'] = 'CAR'
model['xref'] = 83.63
model['yref'] = 22.01
model['outcube'] = 'ctmodel_py1.fits'
model['logfile'] = 'ctmodel_py1.log'
model['chatter'] = 2
# Run ctmodel tool
model.logFileOpen() # Make sure we get a log file
model.run()
model.save()
# Check result file
self._check_result_file('ctmodel_py1.fits')
# Copy ctmodel tool
cpy_model = model.copy()
# Check model cube of ctmodel copy
self._check_cube(cpy_model.cube())
# Execute copy of ctmodel tool again, now with a higher chatter
# level than before
cpy_model['outcube'] = 'ctmodel_py2.fits'
cpy_model['logfile'] = 'ctmodel_py2.log'
cpy_model['publish'] = True
cpy_model['chatter'] = 3
cpy_model.logFileOpen() # Needed to get a new log file
cpy_model.execute()
# Check result file
self._check_result_file('ctmodel_py2.fits')
# Now clear copy of ctmodel tool
cpy_model.clear()
# Check that the cleared copy has also cleared the model cube
self._check_cube(cpy_model.cube(), nx=0, ny=0, nebins=0)
# Get mixed observation container
obs = self._obs_mixed()
# Setup ctmodel tool from observation container and get model cube
# definition from counts cube
model = ctools.ctmodel(obs)
model.models(gammalib.GModels(self._model))
model['incube'] = self._cntcube
model['expcube'] = 'NONE'
model['psfcube'] = 'NONE'
model['bkgcube'] = 'NONE'
model['caldb'] = self._caldb
model['irf'] = self._irf
model['outcube'] = 'ctmodel_py3.fits'
model['logfile'] = 'ctmodel_py3.log'
model['chatter'] = 4
# Execute ctmodel tool
model.logFileOpen() # Needed to get a new log file
model.execute()
# Check result file
self._check_result_file('ctmodel_py3.fits', nx=20, ny=20, nebins=5)
# Publish with name
model.publish('My model')
# Setup ctmodel from event list FITS file
model = ctools.ctmodel()
model['inobs'] = self._events
model['incube'] = 'NONE'
model['inmodel'] = self._model
model['expcube'] = 'NONE'
model['psfcube'] = 'NONE'
model['edispcube'] = 'NONE'
model['bkgcube'] = 'NONE'
model['caldb'] = self._caldb
model['irf'] = self._irf
model['rad'] = 5
model['ra'] = 83.63
model['dec'] = 22.01
model['tmin'] = 0
model['tmax'] = 1800
model['ebinalg'] = 'LOG'
model['emin'] = 1.0
model['emax'] = 100.0
model['enumbins'] = 5
model['nxpix'] = 40
model['nypix'] = 40
model['binsz'] = 0.1
model['coordsys'] = 'CEL'
model['proj'] = 'CAR'
model['xref'] = 83.63
model['yref'] = 22.01
model['outcube'] = 'ctmodel_py4.fits'
model['logfile'] = 'ctmodel_py4.log'
model['chatter'] = 2
# Run ctmodel tool
model.logFileOpen() # Make sure we get a log file
model.execute()
# Check result file
self._check_result_file('ctmodel_py4.fits')
# Setup ctmodel from observation definition XML file
model = ctools.ctmodel()
model['inobs'] = self._obs_unbinned
model['incube'] = 'NONE'
model['inmodel'] = self._model
model['expcube'] = 'NONE'
model['psfcube'] = 'NONE'
model['edispcube'] = 'NONE'
model['bkgcube'] = 'NONE'
model['caldb'] = self._caldb
model['irf'] = self._irf
model['rad'] = 5
model['ra'] = 83.63
model['dec'] = 22.01
model['tmin'] = 0
model['tmax'] = 1800
model['ebinalg'] = 'LOG'
model['emin'] = 1.0
model['emax'] = 100.0
model['enumbins'] = 5
model['nxpix'] = 40
model['nypix'] = 40
model['binsz'] = 0.1
model['coordsys'] = 'CEL'
model['proj'] = 'CAR'
model['xref'] = 83.63
model['yref'] = 22.01
model['outcube'] = 'ctmodel_py5.fits'
model['logfile'] = 'ctmodel_py5.log'
model['chatter'] = 2
# Run ctmodel tool
model.logFileOpen() # Make sure we get a log file
model.execute()
# Check result file
self._check_result_file('ctmodel_py5.fits')
# Setup ctmodel for stacked IRF
model = ctools.ctmodel()
model['inobs'] = 'NONE'
model['incube'] = 'NONE'
model['inmodel'] = self._bkgmodel
model['expcube'] = self._expcube
model['psfcube'] = self._psfcube
model['edispcube'] = 'NONE'
model['bkgcube'] = self._bkgcube
model['edisp'] = False
model['rad'] = 5
model['ra'] = 83.63
model['dec'] = 22.01
model['tmin'] = 0
model['tmax'] = 1800
model['ebinalg'] = 'LOG'
model['emin'] = 1.0
model['emax'] = 100.0
model['enumbins'] = 5
model['nxpix'] = 40
model['nypix'] = 40
model['binsz'] = 0.1
model['coordsys'] = 'CEL'
model['proj'] = 'CAR'
model['xref'] = 83.63
model['yref'] = 22.01
model['outcube'] = 'ctmodel_py6.fits'
model['logfile'] = 'ctmodel_py6.log'
model['chatter'] = 2
# Run ctmodel tool
model.logFileOpen() # Make sure we get a log file
model.execute()
# Check result file
self._check_result_file('ctmodel_py6.fits')
# Setup ctmodel for stacked IRF using energy dispersion
model = ctools.ctmodel()
model['inobs'] = 'NONE'
model['incube'] = 'NONE'
model['inmodel'] = self._bkgmodel
model['expcube'] = self._expcube
model['psfcube'] = self._psfcube
model['edispcube'] = self._edispcube
model['bkgcube'] = self._bkgcube
model['edisp'] = True
model['rad'] = 5
model['ra'] = 83.63
model['dec'] = 22.01
model['tmin'] = 0
model['tmax'] = 1800
model['ebinalg'] = 'LOG'
model['emin'] = 1.0
model['emax'] = 100.0
model['enumbins'] = 5
model['nxpix'] = 40
model['nypix'] = 40
model['binsz'] = 0.1
model['coordsys'] = 'CEL'
model['proj'] = 'CAR'
model['xref'] = 83.63
model['yref'] = 22.01
model['outcube'] = 'ctmodel_py7.fits'
model['logfile'] = 'ctmodel_py7.log'
model['chatter'] = 2
# Run ctmodel tool
model.logFileOpen() # Make sure we get a log file
model.execute()
# Check result file
self._check_result_file('ctmodel_py7.fits')
# Return
return
# Check result file
def _check_result_file(self, filename, nx=40, ny=40, nebins=5):
"""
Check result file
Parameters
----------
filename : str
Model cube file name
nx : int, optional
Number of pixels in X direction
ny : int, optional
Number of pixels in Y direction
nebins : int, optional
Number of energy bins
"""
# Open result file
cube = gammalib.GCTAEventCube(filename)
# Check cube
self._check_cube(cube, nx=nx, ny=ny, nebins=nebins)
# Return
return
# Check model cube
def _check_cube(self, cube, nx=40, ny=40, nebins=5):
"""
Check model cube
Parameters
----------
cube : `~gammalib.GCTAEventCube`
Model cube
nx : int, optional
Number of pixels in X direction
ny : int, optional
Number of pixels in Y direction
nebins : int, optional
Number of energy bins
"""
# Check number of bins per axis
self.test_value(cube.nx(), nx, 'Check number of X pixels')
self.test_value(cube.ny(), ny, 'Check number of Y pixels')
self.test_value(cube.ebins(), nebins, 'Check number of energy bins')
# Return
return