test_ctobssim.py
9.13 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
#! /usr/bin/env python
# ==========================================================================
# This scripts performs unit tests for the ctobssim 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 cscripts import obsutils
from testing import test
# ============================ #
# Test class for ctobssim tool #
# ============================ #
class Test(test):
"""
Test class for ctobssim tools
This test class makes unit tests for the ctobssim tool by using it from
the command line and from Python.
"""
# 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('ctobssim')
# Append tests
self.append(self._test_ctobssim_cmd, 'Test ctobssim on command line')
self.append(self._test_ctobssim_python, 'Test ctobssim from Python')
# Return
return
# Test ctobssim on command line
def _test_ctobssim_cmd(self):
"""
Test ctobssim on the command line
"""
# Set tool name
ctobssim = self._tool('ctobssim')
# Setup ctobssim command
cmd = ctobssim+' inmodel="'+self._model+'" '+ \
' outevents="ctobssim_cmd1.fits"'+ \
' caldb="'+self._caldb+'" irf="'+self._irf+'" '+ \
' ra=83.63 dec=22.01 rad=3.0'+ \
' tmin="2020-01-01T00:00:00"'+ \
' tmax="2020-01-01T00:05:00"'+ \
' emin=0.1 emax=100.0'+ \
' logfile="ctobssim_cmd1.log" chatter=1'
# Check if execution was successful
self.test_assert(self._execute(cmd) == 0,
'Check successful execution from command line')
# Load counts cube and check content.
evt = gammalib.GCTAEventList('ctobssim_cmd1.fits')
self._test_list(evt, 3776)
# Setup ctobssim command
cmd = ctobssim+' inmodel="model_that_does_not_exist.xml"'+ \
' outevents="ctobssim_cmd2.fits"'+ \
' caldb="'+self._caldb+'" irf="'+self._irf+'" '+ \
' ra=83.63 dec=22.01 rad=3.0'+ \
' tmin="2020-01-01T00:00:00"'+ \
' tmax="2020-01-01T00:05:00"'+ \
' emin=0.1 emax=100.0'+ \
' logfile="ctobssim_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 ctobssim --help
self._check_help(ctobssim)
# Return
return
# Test ctobssim from Python
def _test_ctobssim_python(self):
"""
Test ctobssim from Python
"""
# Allocate ctobssim
sim = ctools.ctobssim()
# Check that empty ctobssim tool holds an empty observation
self.test_value(sim.obs().size(), 0, 'Check number of observations')
# Check that saving saves an empty model definition file
sim['outevents'] = 'ctobssim_py0.fits'
sim['logfile'] = 'ctobssim_py0.log'
sim.logFileOpen()
sim.save()
self.test_assert(not os.path.isfile('ctobssim_py0.fits'),
'Check that no event list has been created')
# Check that clearing does not lead to an exception or segfault
sim.clear()
# Now set ctobssim parameters
sim = ctools.ctobssim()
sim['inmodel'] = self._model
sim['caldb'] = self._caldb
sim['irf'] = self._irf
sim['ra'] = 83.63
sim['dec'] = 22.01
sim['rad'] = 3.0
sim['tmin'] = '2020-01-01T00:00:00'
sim['tmax'] = '2020-01-01T00:05:00'
sim['emin'] = 0.1
sim['emax'] = 100.0
sim['outevents'] = 'ctobssim_py1.fits'
sim['logfile'] = 'ctobssim_py1.log'
sim['chatter'] = 2
# Run tool
sim.logFileOpen()
sim.run()
# Check content of observation
self._test_observation(sim)
self._test_list(sim.obs()[0].events(), 3776)
# Save events
sim.save()
# Load counts cube and check content.
evt = gammalib.GCTAEventList('ctobssim_py1.fits')
self._test_list(evt, 3776)
# Copy ctobssim tool
cpy_sim = sim.copy()
# Retrieve observation and check content of copy
self._test_observation(cpy_sim)
self._test_list(cpy_sim.obs()[0].events(), 3776)
# Execute copy of ctobssim tool again, now with a higher chatter
# level than before
cpy_sim['outevents'] = 'ctobssim_py2.fits'
cpy_sim['logfile'] = 'ctobssim_py2.log'
cpy_sim['chatter'] = 3
cpy_sim['publish'] = True
cpy_sim.logFileOpen() # Needed to get a new log file
cpy_sim.execute()
# Load counts cube and check content.
evt = gammalib.GCTAEventList('ctobssim_py2.fits')
self._test_list(evt, 3776)
# Set-up observation container
pnts = [{'ra': 83.63, 'dec': 21.01},
{'ra': 84.63, 'dec': 22.01}]
obs = obsutils.set_obs_list(pnts, caldb=self._caldb, irf=self._irf,
duration=300.0, rad=3.0)
# Set-up ctobssim tool from observation container
sim = ctools.ctobssim(obs)
sim['inmodel'] = self._model
sim['outevents'] = 'ctobssim_py3.xml'
sim['logfile'] = 'ctobssim_py3.log'
sim['chatter'] = 3
# Double maximum event range
max_rate = sim.max_rate()
sim.max_rate(2.0*max_rate)
self.test_value(sim.max_rate(), 2.0*max_rate, 1.0e-3,
'Check setting of maximum event rate')
# Run ctobssim tool
sim.logFileOpen()
sim.run()
# Retrieve observation and check content
self._test_observation(sim, nobs=2, pnts=pnts)
self._test_list(sim.obs()[0].events(), 3569)
self._test_list(sim.obs()[1].events(), 3515)
# Save events
sim.save()
# Load events
obs = gammalib.GObservations('ctobssim_py3.xml')
# Retrieve observation and check content
self._test_list(obs[0].events(), 3569)
self._test_list(obs[1].events(), 3515)
# Return
return
# Check observation
def _test_observation(self, obssim, nobs=1,
pnts=[{'ra': 83.63, 'dec': 22.01}],
ontime=300.0, livetime=294.0):
"""
Test content of an observation
Parameters
----------
obssim : `~ctools.ctobssim`
ctobssim instance
nobs : int
Number of observations
pnts : list of dict
List of pointing dictionaries
"""
# Test observation container
self.test_value(obssim.obs().size(), nobs,
'Check number of observations')
for i, obs in enumerate(obssim.obs()):
pnt = obs.pointing().dir()
ra = pnts[i]['ra']
dec = pnts[i]['dec']
self.test_assert(obs.instrument() == 'CTA',
'Check if observation is CTA observation')
self.test_value(obs.ontime(), ontime, 1.0e-6,
'Check if ontime is %f sec' % ontime)
self.test_value(obs.livetime(), livetime, 1.0e-6,
'Check if livetime is %f sec' % livetime)
self.test_value(pnt.ra_deg(), ra, 1.0e-6,
'Check if pointing Right Ascension is %f deg' % ra)
self.test_value(pnt.dec_deg(), dec, 1.0e-6,
'Check if pointing Declination is %f deg' % dec)
# Return
return
# Check event list
def _test_list(self, eventlist, nevents):
"""
Test content of event list
Parameters
----------
eventlist : `~gammalib.GCTAEventList`
Event list
nevents : int
Expected number of events
"""
# Test event list
self.test_value(eventlist.size(), nevents, str(nevents)+' elements')
self.test_value(eventlist.number(), nevents, str(nevents)+' events')
# Return
return