test_ctbkgcube.py
10 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
#! /usr/bin/env python
# ==========================================================================
# This scripts performs unit tests for the ctbkgcube 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 ctbkgcube tool #
# ============================= #
class Test(test):
"""
Test class for ctbkgcube tool.
"""
# Constructor
def __init__(self):
"""
Constructor
"""
# Call base class constructor
test.__init__(self)
# Return
return
# Set test functions
def set(self):
"""
Set all test functions
"""
# Set test name
self.name('ctbkgcube')
# Append tests
self.append(self._test_cmd, 'Test ctbkgcube on command line')
self.append(self._test_python, 'Test ctbkgcube from Python')
# Return
return
# Test ctbkgcube on command line
def _test_cmd(self):
"""
Test ctbkgcube on the command line.
"""
# Set tool name
ctbkgcube = self._tool('ctbkgcube')
# Setup ctbkgcube command
cmd = ctbkgcube+' inobs="'+self._events+'"'+ \
' inmodel="'+self._model+'"'+ \
' incube="NONE"'+ \
' outcube="ctbkgcube_cmd1.fits"'+ \
' outmodel="ctbkgcube_cmd1.xml"'+ \
' caldb="'+self._caldb+'" irf="'+self._irf+'"'+ \
' ebinalg="LOG" emin=1.0 emax=100.0 enumbins=5'+ \
' nxpix=10 nypix=10 binsz=0.4'+ \
' coordsys="CEL" proj="CAR" xref=83.63 yref=22.01'+ \
' logfile="ctbkgcube_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_files('ctbkgcube_cmd1')
# Setup ctbkgcube command
cmd = ctbkgcube+' inobs="event_file_that_does_not_exist.fits"'+ \
' inmodel="'+self._model+'"'+ \
' incube="NONE"'+ \
' outcube="ctbkgcube_cmd2.fits"'+ \
' outmodel="ctbkgcube_cmd2.xml"'+ \
' caldb="'+self._caldb+'" irf="'+self._irf+'"'+ \
' ebinalg="LOG" emin=1.0 emax=100.0 enumbins=5'+ \
' nxpix=10 nypix=10 binsz=0.4'+ \
' coordsys="CEL" proj="CAR" xref=83.63 yref=22.01'+ \
' logfile="ctbkgcube_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 ctbkgcube --help
self._check_help(ctbkgcube)
# Return
return
# Test ctbkgcube from Python
def _test_python(self):
"""
Test ctbkgcube from Python
"""
# Allocate ctbkgcube
bkgcube = ctools.ctbkgcube()
# Check that empty ctbkgcube tool holds a background cube that has
# no energy bins
self._check_cube(bkgcube.bkgcube(), nebounds=0)
# Check that saving does not nothing
bkgcube['outcube'] = 'ctbkgcube_py0.fits'
bkgcube['outmodel'] = 'ctbkgcube_py0.xml'
bkgcube['logfile'] = 'ctbkgcube_py0.log'
bkgcube.logFileOpen()
bkgcube.save()
self.test_assert(not os.path.isfile('ctbkgcube_py0.fits'),
'Check that no background cube has been created')
# Check model container
self._check_models(gammalib.GModels('ctbkgcube_py0.xml'), nmodels=0)
# Check saving with empty file names
bkgcube['outcube'] = ''
bkgcube['outmodel'] = ''
bkgcube['logfile'] = 'ctbkgcube_py1.log'
bkgcube.logFileOpen()
bkgcube.save()
# Check saving with "none" model definiton name
bkgcube['outcube'] = ''
bkgcube['outmodel'] = 'NONE'
bkgcube['logfile'] = 'ctbkgcube_py2.log'
bkgcube.logFileOpen()
bkgcube.save()
# Check that publish method with user name does not lead to an
# exception or segfault
bkgcube.publish('My background cube')
# Check that clearing does not lead to an exception or segfault
bkgcube.clear()
# Now set ctbkgcube parameters
bkgcube['inobs'] = self._events
bkgcube['inmodel'] = self._model
bkgcube['incube'] = 'NONE'
bkgcube['caldb'] = self._caldb
bkgcube['irf'] = self._irf
bkgcube['ebinalg'] = 'LOG'
bkgcube['emin'] = 1.0
bkgcube['emax'] = 100.0
bkgcube['enumbins'] = 5
bkgcube['nxpix'] = 10
bkgcube['nypix'] = 10
bkgcube['binsz'] = 0.4
bkgcube['coordsys'] = 'CEL'
bkgcube['proj'] = 'CAR'
bkgcube['xref'] = 83.63
bkgcube['yref'] = 22.01
bkgcube['outcube'] = 'ctbkgcube_py3.fits'
bkgcube['outmodel'] = 'ctbkgcube_py3.xml'
bkgcube['logfile'] = 'ctbkgcube_py3.log'
bkgcube['chatter'] = 2
# Run ctbkgcube tool
bkgcube.logFileOpen() # Make sure we get a log file
bkgcube.run()
bkgcube.save()
# Check result files
self._check_result_files('ctbkgcube_py3')
# Copy ctbkgcube tool
cpy_bkgcube = bkgcube.copy()
# Check background cube and model container of ctbkgcube copy
self._check_cube(cpy_bkgcube.bkgcube())
self._check_models(cpy_bkgcube.models())
# Execute copy of ctbkgcube tool again, now with a higher chatter
# level than before. In addition, use counts cube to define the
# background cube
cpy_bkgcube['incube'] = self._cntcube
cpy_bkgcube['outcube'] = 'ctbkgcube_py4.fits'
cpy_bkgcube['outmodel'] = 'ctbkgcube_py4.xml'
cpy_bkgcube['logfile'] = 'ctbkgcube_py4.log'
cpy_bkgcube['chatter'] = 3
cpy_bkgcube['publish'] = True
cpy_bkgcube['addbounds'] = True
cpy_bkgcube.logFileOpen() # Make sure we get a log file
cpy_bkgcube.execute()
# Check result files
self._check_result_files('ctbkgcube_py4')
# Now clear copy of ctbkgcube tool
cpy_bkgcube.clear()
# Check that the cleared copy has also cleared the background cube
# and model container
self._check_cube(cpy_bkgcube.bkgcube(), nebounds=0)
self._check_models(cpy_bkgcube.models(), nmodels=0)
# Get mixel observation container
obs = self._obs_mixed()
obs.models(gammalib.GModels(self._model))
# Set-up ctbkgcube from observation container
bkgcube = ctools.ctbkgcube(obs)
bkgcube['incube'] = ''
bkgcube['caldb'] = self._caldb
bkgcube['irf'] = self._irf
bkgcube['ebinalg'] = 'LOG'
bkgcube['emin'] = 0.2
bkgcube['emax'] = 150.0
bkgcube['enumbins'] = 5
bkgcube['nxpix'] = 10
bkgcube['nypix'] = 10
bkgcube['binsz'] = 0.4
bkgcube['coordsys'] = 'CEL'
bkgcube['proj'] = 'CAR'
bkgcube['xref'] = 83.63
bkgcube['yref'] = 22.01
bkgcube['outcube'] = 'ctbkgcube_py5.fits'
bkgcube['outmodel'] = 'ctbkgcube_py5.xml'
bkgcube['logfile'] = 'ctbkgcube_py5.log'
bkgcube['addbounds'] = True
bkgcube['chatter'] = 4
# Execute ctbkgcube tool
bkgcube.logFileOpen() # Make sure we get a log file
bkgcube.execute()
# Check result files
self._check_result_files('ctbkgcube_py5')
# Return
return
# Check result files
def _check_result_files(self, filename, nebounds=5, nmodels=2):
"""
Check result file
Parameters
----------
filename : str
Test file name without extension
nebounds : int, optional
Number of energy boundaries
"""
# Open background cube
cube = gammalib.GCTACubeBackground(filename+'.fits')
# Open model definition file
models = gammalib.GModels(filename+'.xml')
# Check cube
self._check_cube(cube, nebounds=nebounds)
# Check models
self._check_models(models, nmodels=nmodels)
# Return
return
# Check background cube
def _check_cube(self, cube, nebounds=5):
"""
Check background cube
Parameters
----------
cube : `~gammalib.GCTACubeBackground`
Background cube
nebounds : int, optional
Number of energy boundaries
"""
# Check dimensions
self.test_value(len(cube.ebounds()), nebounds,
'Check number of energy maps')
# Return
return
# Check model container
def _check_models(self, models, nmodels=2):
"""
Check model container
Parameters
----------
models : `~gammalib.GModels`
Model container
"""
# Check number of models
self.test_value(models.size(), nmodels, 'Check number of models')
# Return
return