test_ctskymap.py
17.8 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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
#! /usr/bin/env python
# ==========================================================================
# This scripts performs unit tests for the ctskymap 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 ctskymap tool #
# ============================ #
class Test(test):
"""
Test class for ctskymap tool
"""
# Constructor
def __init__(self):
"""
Constructor
"""
# Call base class constructor
test.__init__(self)
# Set test data
self._skymap_ring = self._datadir + '/skymap_ring.fits'
self._exclusion_region = self._datadir + '/exclusion.reg'
self._exclusion_map = self._datadir + '/exclusion.fits'
# Return
return
# Set test functions
def set(self):
"""
Set all test functions
"""
# Set test name
self.name('ctskymap')
# Append tests
self.append(self._test_cmd, 'Test ctskymap on command line')
self.append(self._test_python, 'Test ctskymap from Python')
self.append(self._test_python_irf,
'Test ctskymap from Python for IRF background')
self.append(self._test_python_ring,
'Test ctskymap from Python for RING background')
self.append(self._test_python_exclusion_map,
'Test ctskymap exclusion map methods from Python')
# Return
return
# Test ctskymap on command line
def _test_cmd(self):
"""
Test ctskymap on the command line
"""
# Set tool name
ctskymap = self._tool('ctskymap')
# Setup ctskymap command
cmd = ctskymap+' inobs="'+self._events+'"'+\
' outmap="ctskymap_cmd1.fits"'+ \
' emin=0.1 emax=100.0 nxpix=20 nypix=20'+ \
' binsz=0.2 coordsys="CEL" proj="CAR"'+ \
' xref=83.63 yref=22.01 bkgsubtract="NONE"'+ \
' logfile="ctskymap_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('ctskymap_cmd1.fits')
# Setup ctskymap command
cmd = ctskymap+' inobs="event_file_that_does_not_exist.fits"'+\
' outmap="ctskymap_cmd2.fits"'+ \
' emin=0.1 emax=100.0 nxpix=20 nypix=20'+ \
' binsz=0.2 coordsys="CEL" proj="CAR"'+ \
' xref=83.63 yref=22.01 bkgsubtract="NONE"'+ \
' logfile="ctskymap_cmd2.log" debug=yes chatter=2'
# Check if execution failed
self.test_assert(self._execute(cmd, success=False) != 0,
'Check invalid input file when executed from command line')
# Check ctskymap --help
self._check_help(ctskymap)
# Return
return
# Test ctskymap from Python
def _test_python(self):
"""
Test ctskymap from Python
"""
# Allocate ctskymap
skymap = ctools.ctskymap()
# Check that empty ctskymap tool holds a map that has no pixels
self._check_map(skymap.skymap(), nx=0, ny=0)
# Check that saving does not nothing
skymap['outmap'] = 'ctskymap_py0.fits'
skymap['logfile'] = 'ctskymap_py0.log'
skymap.logFileOpen()
skymap.save()
self.test_assert(not os.path.isfile('ctskymap_py0.fits'),
'Check that no sky map has been created')
# Check that clearing does not lead to an exception or segfault
skymap.clear()
# Now set ctskymap parameters
skymap['inobs'] = self._events
skymap['emin'] = 0.1
skymap['emax'] = 100
skymap['nxpix'] = 20
skymap['nypix'] = 20
skymap['binsz'] = 0.2
skymap['coordsys'] = 'CEL'
skymap['proj'] = 'CAR'
skymap['xref'] = 83.63
skymap['yref'] = 22.01
skymap['bkgsubtract'] = 'NONE'
skymap['outmap'] = 'ctskymap_py1.fits'
skymap['logfile'] = 'ctskymap_py1.log'
skymap['chatter'] = 2
# Run ctskymap tool
skymap.logFileOpen() # Make sure we get a log file
skymap.run()
skymap.save()
# Check result file
self._check_result_file('ctskymap_py1.fits')
# Copy ctskymap tool
cpy_skymap = skymap.copy()
# Check sky map of ctskymap copy
self._check_map(cpy_skymap.skymap())
# Execute copy of ctskymap tool again, now with a higher chatter
# level than before
cpy_skymap['usepnt'] = True
cpy_skymap['emin'] = 0.2
cpy_skymap['emax'] = 150.0
cpy_skymap['coordsys'] = 'GAL'
cpy_skymap['proj'] = 'CAR'
cpy_skymap['outmap'] = 'ctskymap_py2.fits'
cpy_skymap['logfile'] = 'ctskymap_py2.log'
cpy_skymap['publish'] = True
cpy_skymap['chatter'] = 3
cpy_skymap.logFileOpen() # Needed to get a new log file
cpy_skymap.execute()
# Check result file
self._check_result_file('ctskymap_py2.fits')
# Now clear copy of ctskymap tool
cpy_skymap.clear()
# Check that cleared ctskymap tool holds a map that has no pixels
self._check_map(cpy_skymap.skymap(), nx=0, ny=0)
# Get mixed observation container
obs = self._obs_mixed()
# Allocate ctskymap tool from observation container
skymap = ctools.ctskymap(obs)
skymap['emin'] = 0.1
skymap['emax'] = 100
skymap['nxpix'] = 20
skymap['nypix'] = 20
skymap['binsz'] = 0.2
skymap['coordsys'] = 'GAL'
skymap['proj'] = 'CAR'
skymap['xref'] = 184.5575
skymap['yref'] = -5.7844
skymap['bkgsubtract'] = 'NONE'
skymap['outmap'] = 'ctskymap_py3.fits'
skymap['logfile'] = 'ctskymap_py3.log'
skymap['chatter'] = 4
# Execute tool
skymap.logFileOpen() # Needed to get a new log file
skymap.execute()
# Check result file
self._check_result_file('ctskymap_py3.fits')
# Publish with name
skymap.publish('My sky map')
# Return
return
# Test ctskymap from Python for IRF background method
def _test_python_irf(self):
"""
Test ctskymap from Python for IRF background method
"""
# Test IRF background subtraction
skymap = ctools.ctskymap()
skymap['inobs'] = self._events
skymap['emin'] = 0.1
skymap['emax'] = 100
skymap['nxpix'] = 20
skymap['nypix'] = 20
skymap['binsz'] = 0.2
skymap['coordsys'] = 'GAL'
skymap['proj'] = 'CAR'
skymap['xref'] = 184.5575
skymap['yref'] = -5.7844
skymap['bkgsubtract'] = 'IRF'
skymap['caldb'] = self._caldb
skymap['irf'] = self._irf
skymap['outmap'] = 'ctskymap_irf_py1.fits'
skymap['logfile'] = 'ctskymap_irf_py1.log'
skymap['chatter'] = 2
# Execute tool
skymap.logFileOpen() # Needed to get a new log file
skymap.execute()
# Check result file
self._check_result_file('ctskymap_irf_py1.fits')
self._check_result_file('ctskymap_irf_py1.fits[BACKGROUND]')
self._check_result_file('ctskymap_irf_py1.fits[SIGNIFICANCE]')
# Return
return
# Test ctskymap from Python for RING background method
def _test_python_ring(self):
"""
Test ctskymap from Python for RING background method
"""
# Test basic RING background subtraction
skymap = ctools.ctskymap()
skymap['inobs'] = self._events
skymap['emin'] = 0.1
skymap['emax'] = 100
skymap['nxpix'] = 10
skymap['nypix'] = 10
skymap['binsz'] = 0.2
skymap['coordsys'] = 'CEL'
skymap['proj'] = 'CAR'
skymap['xref'] = 83.63
skymap['yref'] = 22.01
skymap['bkgsubtract'] = 'RING'
skymap['roiradius'] = 0.1
skymap['inradius'] = 0.6
skymap['outradius'] = 0.8
skymap['iterations'] = 0
skymap['inexclusion'] = 'NONE'
skymap['caldb'] = self._caldb
skymap['irf'] = self._irf
skymap['outmap'] = 'ctskymap_ring_py1.fits'
skymap['logfile'] = 'ctskymap_ring_py1.log'
skymap['chatter'] = 2
# Execute tool
skymap.logFileOpen() # Needed to get a new log file
skymap.execute()
# Check result file
self._check_result_file('ctskymap_ring_py1.fits', 10, 10)
self._check_result_file('ctskymap_ring_py1.fits[BACKGROUND]', 10, 10)
self._check_result_file('ctskymap_ring_py1.fits[SIGNIFICANCE]', 10, 10)
# Check generated fits object
self._check_map(gammalib.GSkyMap(skymap.fits().image('SKYMAP')), nx=10, ny=10)
self._check_map(gammalib.GSkyMap(skymap.fits().image('BACKGROUND')), nx=10, ny=10)
self._check_map(gammalib.GSkyMap(skymap.fits().image('SIGNIFICANCE')), nx=10, ny=10)
# Test iterative RING background subtraction
skymap = ctools.ctskymap()
skymap['inobs'] = self._events
skymap['emin'] = 0.1
skymap['emax'] = 100
skymap['nxpix'] = 10
skymap['nypix'] = 10
skymap['binsz'] = 0.2
skymap['coordsys'] = 'CEL'
skymap['proj'] = 'CAR'
skymap['xref'] = 83.63
skymap['yref'] = 22.01
skymap['bkgsubtract'] = 'RING'
skymap['roiradius'] = 0.1
skymap['inradius'] = 0.6
skymap['outradius'] = 0.8
skymap['iterations'] = 2
skymap['threshold'] = 5.0
skymap['inexclusion'] = 'NONE'
skymap['caldb'] = self._caldb
skymap['irf'] = self._irf
skymap['outmap'] = 'ctskymap_ring_py2.fits'
skymap['logfile'] = 'ctskymap_ring_py2.log'
skymap['chatter'] = 2
# Execute tool
skymap.logFileOpen() # Needed to get a new log file
skymap.execute()
# Check result file
self._check_result_file('ctskymap_ring_py2.fits', 10, 10)
self._check_result_file('ctskymap_ring_py2.fits[BACKGROUND]', 10, 10)
self._check_result_file('ctskymap_ring_py2.fits[SIGNIFICANCE]', 10, 10)
# Test iterative RING background subtraction, starting from a sky map
skymap = ctools.ctskymap()
skymap['inmap'] = self._skymap_ring
skymap['bkgsubtract'] = 'RING'
skymap['roiradius'] = 0.1
skymap['inradius'] = 0.6
skymap['outradius'] = 0.8
skymap['iterations'] = 2
skymap['threshold'] = 5.0
skymap['inexclusion'] = 'NONE'
skymap['outmap'] = 'ctskymap_ring_py3.fits'
skymap['logfile'] = 'ctskymap_ring_py3.log'
skymap['chatter'] = 2
# Execute tool
skymap.logFileOpen() # Needed to get a new log file
skymap.execute()
# Check result file
self._check_result_file('ctskymap_ring_py3.fits', 10, 10)
self._check_result_file('ctskymap_ring_py3.fits[BACKGROUND]', 10, 10)
self._check_result_file('ctskymap_ring_py3.fits[SIGNIFICANCE]', 10, 10)
# Test iterative RING background subtraction with an exclusion region
skymap = ctools.ctskymap()
skymap['inmap'] = self._skymap_ring
skymap['bkgsubtract'] = 'RING'
skymap['roiradius'] = 0.1
skymap['inradius'] = 0.6
skymap['outradius'] = 0.8
skymap['iterations'] = 2
skymap['threshold'] = 5.0
skymap['inexclusion'] = self._exclusion_region
skymap['outmap'] = 'ctskymap_ring_py4.fits'
skymap['logfile'] = 'ctskymap_ring_py4.log'
skymap['chatter'] = 2
# Execute tool
skymap.logFileOpen() # Needed to get a new log file
skymap.execute()
# Check result file
self._check_result_file('ctskymap_ring_py4.fits', 10, 10)
self._check_result_file('ctskymap_ring_py4.fits[BACKGROUND]', 10, 10)
self._check_result_file('ctskymap_ring_py4.fits[SIGNIFICANCE]', 10, 10)
# Test iterative RING background subtraction with an exclusion map
skymap = ctools.ctskymap()
skymap['inmap'] = self._skymap_ring
skymap['bkgsubtract'] = 'RING'
skymap['roiradius'] = 0.1
skymap['inradius'] = 0.6
skymap['outradius'] = 0.8
skymap['iterations'] = 2
skymap['threshold'] = 5.0
skymap['inexclusion'] = self._exclusion_map
skymap['outmap'] = 'ctskymap_ring_py5.fits'
skymap['logfile'] = 'ctskymap_ring_py5.log'
skymap['chatter'] = 2
# Execute tool
skymap.logFileOpen() # Needed to get a new log file
skymap.execute()
# Check result file
self._check_result_file('ctskymap_ring_py5.fits', 10, 10)
self._check_result_file('ctskymap_ring_py5.fits[BACKGROUND]', 10, 10)
self._check_result_file('ctskymap_ring_py5.fits[SIGNIFICANCE]', 10, 10)
# Test RING background subtraction with direct significance computation
skymap = ctools.ctskymap()
skymap['inmap'] = self._skymap_ring
skymap['bkgsubtract'] = 'RING'
skymap['roiradius'] = 0.1
skymap['inradius'] = 0.6
skymap['outradius'] = 0.8
skymap['iterations'] = 0
skymap['threshold'] = 5.0
skymap['inexclusion'] = 'NONE'
skymap['usefft'] = False # Direct computation, no FFT
skymap['outmap'] = 'ctskymap_ring_py6.fits'
skymap['logfile'] = 'ctskymap_ring_py6.log'
skymap['chatter'] = 2
# Execute tool
skymap.logFileOpen() # Needed to get a new log file
skymap.execute()
# Check result file
self._check_result_file('ctskymap_ring_py6.fits', 10, 10)
self._check_result_file('ctskymap_ring_py6.fits[BACKGROUND]', 10, 10)
self._check_result_file('ctskymap_ring_py6.fits[SIGNIFICANCE]', 10, 10)
# Return
return
# Test exclusion_map methods
def _test_python_exclusion_map(self):
"""
Test exclusion_map methods
"""
# Setup ctskymap
skymap = ctools.ctskymap()
# Set exclusion map
map = gammalib.GSkyRegionMap(self._exclusion_map)
# Test iterative RING background subtraction with an exclusion map
# set via the ctskymap::exclusion_map() method
skymap = ctools.ctskymap()
skymap['inmap'] = self._skymap_ring
skymap['bkgsubtract'] = 'RING'
skymap['roiradius'] = 0.1
skymap['inradius'] = 0.6
skymap['outradius'] = 0.8
skymap['iterations'] = 2
skymap['threshold'] = 5.0
skymap['outmap'] = 'ctskymap_ring_py7.fits'
skymap['logfile'] = 'ctskymap_ring_py7.log'
skymap['chatter'] = 2
skymap.exclusion_map(map)
# Execute tool
skymap.logFileOpen() # Needed to get a new log file
skymap.execute()
# Check result file
self._check_result_file('ctskymap_ring_py7.fits', 10, 10)
self._check_result_file('ctskymap_ring_py7.fits[BACKGROUND]', 10, 10)
self._check_result_file('ctskymap_ring_py7.fits[SIGNIFICANCE]', 10, 10)
# Recover exclusion map
map2 = skymap.exclusion_map()
# Check exclusion map
self._check_map(map2.map(), nx=10, ny=10)
# Return
return
# Check result file
def _check_result_file(self, filename, nx=20, ny=20):
"""
Check result file
Parameters
----------
filename : str
Sky map file name
nx : int, optional
Number of X pixels
ny : int, optional
Number of Y pixels
"""
# Open result file
skymap = gammalib.GSkyMap(filename)
# Check sky map
self._check_map(skymap, nx=nx, ny=ny)
# Return
return
# Check sky map
def _check_map(self, skymap, nx=20, ny=20):
"""
Check sky map
Parameters
----------
skymap : `~gammalib.GSkyMap`
Sky map
nx : int, optional
Number of X pixels
ny : int, optional
Number of Y pixels
"""
# Determine number of maps
if nx > 0 and ny > 0:
nmaps = 1
else:
nmaps = 0
# Check dimensions
self.test_value(skymap.nmaps(), nmaps, 'Check number of maps')
self.test_value(skymap.nx(), nx, 'Check for number of X pixels')
self.test_value(skymap.ny(), ny, 'Check for number of Y pixels')
# Return
return