test_obsutils.py
15.4 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
#! /usr/bin/env python
# ==========================================================================
# This scripts performs unit tests for the obsutils module
#
# Copyright (C) 2017 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 gammalib
from cscripts import obsutils
from testing import test
# =============================== #
# Test class for csviscube script #
# =============================== #
class Test(test):
"""
Test class for csviscube script
"""
# 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('obsutils')
# Append tests
self.append(self._test_sim_unbinned,
'Test obsutils.sim() function in unbinned mode')
self.append(self._test_sim_binned,
'Test obsutils.sim() function in binned mode')
self.append(self._test_sim_stacked,
'Test obsutils.sim() function in stacked mode')
self.append(self._test_sim_stacked_edisp,
'Test obsutils.sim() function in stacked mode with energy '
'dispersion')
self.append(self._test_sim_onoff,
'Test obsutils.sim() function in On/Off mode')
self.append(self._test_sim_log,
'Test obsutils.sim() function with logging switched on')
self.append(self._test_set_obs,
'Test obsutils.set_obs() function')
self.append(self._test_set_obs_list,
'Test obsutils.set_obs_list() function')
self.append(self._test_set_obs_patterns,
'Test obsutils.set_obs_patterns() function')
self.append(self._test_set_observations,
'Test obsutils.set_observations() function')
self.append(self._test_get_stacked_response,
'Test obsutils.get_stacked_response() function')
self.append(self._test_get_stacked_obs,
'Test obsutils.get_stacked_obs() function')
# Return
return
# Setup method for sim() function test
def _setup_sim(self, two=False):
"""
Setup method for sim() function test
"""
# Set-up observation container
pnt = gammalib.GSkyDir()
pnt.radec_deg(83.6331, 22.0145)
obs = gammalib.GObservations()
run = obsutils.set_obs(pnt, duration=100.0, emin=1.0, emax=10.0)
run.id('0')
obs.append(run)
if two:
run.id('1')
obs.append(run)
# Append model
obs.models(gammalib.GModels(self._model))
# Return
return obs
# Test sim() function in unbinned mode
def _test_sim_unbinned(self):
"""
Test sim() function in unbinned mode
"""
# Simulate unbinned observations
res = obsutils.sim(self._setup_sim())
# Check simulation results
self.test_value(res.size(), 1, 'Check number of observations')
self.test_value(res.models().size(), 2, 'Check number of models')
self.test_value(res.nobserved(), 40, 'Check number of observed events')
self.test_value(res.npred(), 0.0, 'Check number of predicted events')
self.test_value(res[0].eventtype(), 'EventList', 'Check event type')
self.test_value(res[0].events().ebounds().emin().TeV(), 1.0,
'Check minimum energy')
self.test_value(res[0].events().ebounds().emax().TeV(), 10.0,
'Check minimum energy')
self.test_value(res[0].events().number(), 40,
'Check number of events in list')
# Check energy dispersion flag
self.test_assert(not (res[0].response().use_edisp()),
'Check energy dispersion usage')
res[0].response().apply_edisp(True)
self.test_assert(res[0].response().use_edisp(),
'Check energy dispersion usage')
# Return
return
# Test sim() function in binned mode
def _test_sim_binned(self):
"""
Test sim() function in binned mode
"""
# Simulate binned observations
res = obsutils.sim(self._setup_sim(), nbins=5)
# Check simulation results
self.test_value(res.size(), 1, 'Check number of observations')
self.test_value(res.models().size(), 2, 'Check number of models')
self.test_value(res.nobserved(), 40, 'Check number of observed events')
self.test_value(res.npred(), 0.0, 'Check number of predicted events')
self.test_value(res[0].eventtype(), 'CountsCube', 'Check event type')
self.test_value(res[0].events().ebounds().emin().TeV(), 1.0,
'Check minimum energy')
self.test_value(res[0].events().ebounds().emax().TeV(), 10.0,
'Check minimum energy')
self.test_value(res[0].events().ebounds().size(), 5,
'Check number of energy bins')
self.test_value(res[0].events().number(), 40,
'Check number of events in cube')
# Check energy dispersion flag
self.test_assert(not (res[0].response().use_edisp()),
'Check energy dispersion usage')
res[0].response().apply_edisp(True)
self.test_assert(res[0].response().use_edisp(),
'Check energy dispersion usage')
# Return
return
# Test sim() function in stacked mode
def _test_sim_stacked(self):
"""
Test sim() function in stacked mode
"""
# Simulate stacked observations
res = obsutils.sim(self._setup_sim(two=True), nbins=5)
# Check simulation results
self.test_value(res.size(), 1, 'Check number of observations')
self.test_value(res.models().size(), 2, 'Check number of models')
self.test_value(res.nobserved(), 86, 'Check number of observed events')
self.test_value(res.npred(), 0.0, 'Check number of predicted events')
self.test_value(res[0].eventtype(), 'CountsCube', 'Check event type')
self.test_value(res[0].events().ebounds().emin().TeV(), 1.0,
'Check minimum energy')
self.test_value(res[0].events().ebounds().emax().TeV(), 10.0,
'Check minimum energy')
self.test_value(res[0].events().ebounds().size(), 5,
'Check number of energy bins')
self.test_value(res[0].events().number(), 86,
'Check number of events in cube')
# Check energy dispersion flag
self.test_assert(not (res[0].response().use_edisp()),
'Check energy dispersion usage')
res[0].response().apply_edisp(True)
self.test_assert(not (res[0].response().use_edisp()),
'Check energy dispersion usage')
# Return
return
# Test sim() function in stacked mode with energy dispersion
def _test_sim_stacked_edisp(self):
"""
Test sim() function in stacked mode with energy dispersion
"""
# Simulate binned observations
res = obsutils.sim(self._setup_sim(two=True), nbins=5, edisp=True,
log=True)
# Check simulation results
self.test_value(res.size(), 1, 'Check number of observations')
self.test_value(res.models().size(), 2, 'Check number of models')
self.test_value(res.nobserved(), 82, 'Check number of observed events')
self.test_value(res.npred(), 0.0, 'Check number of predicted events')
self.test_value(res[0].eventtype(), 'CountsCube', 'Check event type')
self.test_value(res[0].events().ebounds().emin().TeV(), 1.0,
'Check minimum energy')
self.test_value(res[0].events().ebounds().emax().TeV(), 10.0,
'Check minimum energy')
self.test_value(res[0].events().ebounds().size(), 5,
'Check number of energy bins')
self.test_value(res[0].events().number(), 82,
'Check number of events in cube')
# Check energy dispersion flag
self.test_assert(not (res[0].response().use_edisp()),
'Check energy dispersion usage')
res[0].response().apply_edisp(True)
self.test_assert(res[0].response().use_edisp(),
'Check energy dispersion usage')
# Return
return
# Test sim() function in On/Off mode
def _test_sim_onoff(self):
"""
Test sim() function in On/Off mode
"""
# Set-up observation container
pnt = gammalib.GSkyDir()
pnt.radec_deg(83.63, 22.51)
obs = gammalib.GObservations()
run = obsutils.set_obs(pnt, duration=100.0, emin=1.0, emax=10.0, obsid='0')
obs.append(run)
pnt.radec_deg(83.63, 21.51)
run = obsutils.set_obs(pnt, duration=100.0, emin=1.0, emax=10.0, obsid='1')
obs.append(run)
obs.models(gammalib.GModels(self._model))
# Simulate stacked observations
res = obsutils.sim(obs, onsrc='Crab', nbins=5)
# Check simulation results
self.test_value(res.size(), 2, 'Check number of observations')
self.test_value(res.models().size(), 2, 'Check number of models')
self.test_value(res.nobserved(), 46, 'Check number of observed events')
self.test_value(res.npred(), 0.0, 'Check number of predicted events')
self.test_value(res[0].on_spec().ebounds().emin().TeV(), 1.0,
'Check minimum energy of On spectrum')
self.test_value(res[0].on_spec().ebounds().emax().TeV(), 10.0,
'Check minimum energy of On spectrum')
self.test_value(res[0].on_spec().ebounds().size(), 5,
'Check number of energy bins of On spectrum')
self.test_value(res[0].on_spec().counts(), 24,
'Check number of events in of On spectrum')
self.test_value(res[0].off_spec().ebounds().emin().TeV(), 1.0,
'Check minimum energy of Off spectrum')
self.test_value(res[0].off_spec().ebounds().emax().TeV(), 10.0,
'Check minimum energy of Off spectrum')
self.test_value(res[0].off_spec().ebounds().size(), 5,
'Check number of energy bins of Off spectrum')
self.test_value(res[0].off_spec().counts(), 2,
'Check number of events in of Off spectrum')
self.test_value(res[0].arf().ebounds().emin().TeV(), 0.5,
'Check minimum energy of ARF')
self.test_value(res[0].arf().ebounds().emax().TeV(), 12.0,
'Check minimum energy of ARF')
self.test_value(res[0].arf().ebounds().size(), 42,
'Check number of energy bins of ARF')
self.test_value(res[0].rmf().etrue().emin().TeV(), 0.5,
'Check minimum true energy of RMF')
self.test_value(res[0].rmf().etrue().emax().TeV(), 12.0,
'Check minimum true energy of RMF')
self.test_value(res[0].rmf().etrue().size(), 42,
'Check number of true energy bins of RMF')
self.test_value(res[0].rmf().emeasured().emin().TeV(), 1.0,
'Check minimum reconstructed energy of RMF')
self.test_value(res[0].rmf().emeasured().emax().TeV(), 10.0,
'Check minimum reconstructed energy of RMF')
self.test_value(res[0].rmf().emeasured().size(), 5,
'Check number of reconstructed energy bins of RMF')
# Return
return
# Test sim() function with logging switched on
def _test_sim_log(self):
"""
Test sim() function with logging switched on
"""
# Simulate unbinned observations
res = obsutils.sim(self._setup_sim(), log=True)
# Check simulation results
self.test_value(res.size(), 1, 'Check number of observations')
self.test_value(res.models().size(), 2, 'Check number of models')
self.test_value(res.nobserved(), 40, 'Check number of observed events')
self.test_value(res.npred(), 0.0, 'Check number of predicted events')
self.test_value(res[0].eventtype(), 'EventList', 'Check event type')
self.test_value(res[0].events().ebounds().emin().TeV(), 1.0,
'Check minimum energy')
self.test_value(res[0].events().ebounds().emax().TeV(), 10.0,
'Check minimum energy')
# Check energy dispersion flag
self.test_assert(not (res[0].response().use_edisp()),
'Check energy dispersion usage')
res[0].response().apply_edisp(True)
self.test_assert(res[0].response().use_edisp(),
'Check energy dispersion usage')
# Return
return
# Test set_obs() function
def _test_set_obs(self):
"""
Test set_obs() function
"""
# TODO: implement
# Return
return
# Test set_obs_list() function
def _test_set_obs_list(self):
"""
Test set_obs_list() function
"""
# TODO: implement
# Return
return
# Test set_obs_patterns() function
def _test_set_obs_patterns(self):
"""
Test set_obs_pattern() function
"""
# Get single observation pattern
res = obsutils.set_obs_patterns('single')
self.test_value(len(res), 1, 'Check number of observations for '
'"single" pattern')
# Get four observation pattern
res = obsutils.set_obs_patterns('four')
self.test_value(len(res), 4, 'Check number of observations for "four"'
' pattern')
# Get invalud observations pattern
self.test_try('Check invalid pointing pattern')
try:
res = obsutils.set_obs_patterns('five')
self.test_try_failure('Exception not thrown')
except RuntimeError:
self.test_try_success()
# Return
return
# Test set_observations() function
def _test_set_observations(self):
"""
Test set_observations() function
"""
# TODO: implement
# Return
return
# Test get_stacked_response() function
def _test_get_stacked_response(self):
"""
Test get_stacked_response() function
"""
# TODO: implement
# Return
return
# Test get_stacked_obs() function
def _test_get_stacked_obs(self):
"""
Test get_stacked_obs() function
"""
# TODO: implement
# Return
return