test_csbkgmodel.py 14.5 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
#! /usr/bin/env python
# ==========================================================================
# This scripts performs unit tests for the csbkgmodel script.
#
# Copyright (C) 2019 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
import cscripts
from testing import test


# ================================ #
# Test class for csbkgmodel script #
# ================================ #
class Test(test):
    """
    Test class for csbkgmodel script

    This test class makes unit tests for the csbkgmodel script by using it
    from the command line and from Python.
    """

    # Constructor
    def __init__(self):
        """
        Constructor
        """
        # Call base class constructor
        test.__init__(self)

        # Set test datasets and parameters
        self._myevents1 = self._datadir + '/crab_offaxis1.fits'
        self._myevents2 = self._datadir + '/crab_offaxis2.fits'
        self._lookup    = self._datadir + '/hess_bkg_lookup.fits'

        # Return
        return

    # Set test functions
    def set(self):
        """
        Set all test functions.
        """
        # Set test name
        self.name('csbkgmodel')

        # Append tests
        self.append(self._test_cmd, 'Test csbkgmodel on command line')
        self.append(self._test_python, 'Test csbkgmodel from Python')
        self.append(self._test_pickeling, 'Test csbkgmodel pickeling')

        # Return
        return

    # Test csbkgmodel on command line
    def _test_cmd(self):
        """
        Test csbkgmodel on the command line.
        """
        # Set script name
        csbkgmodel = self._script('csbkgmodel')

        # Setup csbkgmodel command
        cmd = csbkgmodel+' inobs="'+self._events+'"'+ \
                         ' caldb="'+self._caldb+'" irf="'+self._irf+'"' \
                         ' instrument=CTA spatial=GAUSS gradient=yes'+ \
                         ' spectral=NODES ebinalg=LOG emin=1.0 emax=100.0'+ \
                         ' enumbins=8 runwise=yes rad=2.0'+ \
                         ' outmodel="csbkgmodel_cmd1.xml"'+ \
                         ' logfile="csbkgmodel_cmd1.log" chatter=4'

        # Check if execution was successful
        self.test_assert(self._execute(cmd) == 0,
             'Check successful execution from command line')

        # Check background model
        self._check_bkg_model('csbkgmodel_cmd1.xml')

        # Setup csbkgmodel command
        cmd = csbkgmodel+' inobs="events_that_do_not_exist.fits"'+ \
                         ' caldb="'+self._caldb+'" irf="'+self._irf+'"' \
                         ' instrument=CTA spatial=GAUSS gradient=yes'+ \
                         ' spectral=NODES ebinalg=LOG emin=1.0 emax=100.0'+ \
                         ' enumbins=8 runwise=yes rad=2.0'+ \
                         ' outmodel="csbkgmodel_cmd2.xml"' + \
                         ' logfile="csbkgmodel_cmd2.log" 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 csbkgmodel --help
        self._check_help(csbkgmodel)

        # Return
        return

    # Test csbkgmodel from Python
    def _test_python(self):
        """
        Test csbkgmodel from Python
        """
        # Set-up csbkgmodel
        bkgmodel = cscripts.csbkgmodel()
        bkgmodel['inobs']      = self._events
        bkgmodel['caldb']      = self._caldb
        bkgmodel['irf']        = self._irf
        bkgmodel['instrument'] = 'CTA'
        bkgmodel['spatial']    = 'GAUSS'
        bkgmodel['gradient']   = True
        bkgmodel['spectral']   = 'NODES'
        bkgmodel['ebinalg']    = 'LOG'
        bkgmodel['emin']       = 1.0
        bkgmodel['emax']       = 100.0
        bkgmodel['enumbins']   = 8
        bkgmodel['runwise']    = True
        bkgmodel['rad']        = 2.0
        bkgmodel['chatter']    = 2
        bkgmodel['outmodel']   = 'csbkgmodel_py1.xml'
        bkgmodel['logfile']    = 'csbkgmodel_py1.log'

        # Run csbkgmodel script and save background model
        bkgmodel.logFileOpen()   # Make sure we get a log file
        bkgmodel.run()
        bkgmodel.save()

        # Check background model
        self._check_bkg_model('csbkgmodel_py1.xml')

        # Now test without gradient, power law and not runwise
        bkgmodel = cscripts.csbkgmodel()
        bkgmodel['inobs']      = self._events
        bkgmodel['caldb']      = self._caldb
        bkgmodel['irf']        = self._irf
        bkgmodel['instrument'] = 'CTA'
        bkgmodel['spatial']    = 'GAUSS'
        bkgmodel['gradient']   = False
        bkgmodel['spectral']   = 'PLAW'
        bkgmodel['ebinalg']    = 'LOG'
        bkgmodel['emin']       = 1.0
        bkgmodel['emax']       = 100.0
        bkgmodel['enumbins']   = 8
        bkgmodel['runwise']    = False
        bkgmodel['rad']        = 2.0
        bkgmodel['chatter']    = 3
        bkgmodel['outmodel']   = 'csbkgmodel_py2.xml'
        bkgmodel['logfile']    = 'csbkgmodel_py2.log'

        # Execute csbkgmodel script
        bkgmodel.logFileOpen()   # Make sure we get a log file
        bkgmodel.execute()

        # Check background model
        self._check_bkg_model('csbkgmodel_py2.xml')

        # Now test AEFF model
        bkgmodel = cscripts.csbkgmodel()
        bkgmodel['inobs']      = self._events
        bkgmodel['caldb']      = self._caldb
        bkgmodel['irf']        = self._irf
        bkgmodel['instrument'] = 'CTA'
        bkgmodel['spatial']    = 'AEFF'
        bkgmodel['gradient']   = False
        bkgmodel['spectral']   = 'PLAW'
        bkgmodel['ebinalg']    = 'LOG'
        bkgmodel['emin']       = 1.0
        bkgmodel['emax']       = 100.0
        bkgmodel['enumbins']   = 8
        bkgmodel['runwise']    = False
        bkgmodel['rad']        = 2.0
        bkgmodel['chatter']    = 4
        bkgmodel['outmodel']   = 'csbkgmodel_py3.xml'
        bkgmodel['logfile']    = 'csbkgmodel_py3.log'

        # Execute csbkgmodel script
        bkgmodel.logFileOpen()   # Make sure we get a log file
        bkgmodel.execute()

        # Check background model
        self._check_bkg_model('csbkgmodel_py3.xml')

        # Now test IRF model
        bkgmodel = cscripts.csbkgmodel()
        bkgmodel['inobs']      = self._events
        bkgmodel['caldb']      = self._caldb
        bkgmodel['irf']        = self._irf
        bkgmodel['instrument'] = 'CTA'
        bkgmodel['spatial']    = 'IRF'
        bkgmodel['gradient']   = False
        bkgmodel['spectral']   = 'PLAW'
        bkgmodel['ebinalg']    = 'LOG'
        bkgmodel['emin']       = 1.0
        bkgmodel['emax']       = 100.0
        bkgmodel['enumbins']   = 8
        bkgmodel['runwise']    = False
        bkgmodel['rad']        = 2.0
        bkgmodel['chatter']    = 4
        bkgmodel['outmodel']   = 'csbkgmodel_py4.xml'
        bkgmodel['logfile']    = 'csbkgmodel_py4.log'

        # Execute csbkgmodel script
        bkgmodel.logFileOpen()   # Make sure we get a log file
        bkgmodel.execute()

        # Check background model
        self._check_bkg_model('csbkgmodel_py4.xml')

        # Test with multiple input observations
        obs = gammalib.GObservations()
        for s, events in enumerate([self._myevents1, self._myevents2]):
            run = gammalib.GCTAObservation(events)
            run.id(str(s + 1))
            run.response(self._irf, gammalib.GCaldb('cta', self._caldb))
            obs.append(run)

        # Set-up csbkgmodel
        bkgmodel = cscripts.csbkgmodel(obs)
        bkgmodel['instrument'] = 'CTA'
        bkgmodel['spatial']    = 'GAUSS'
        bkgmodel['gradient']   = True
        bkgmodel['spectral']   = 'NODES'
        bkgmodel['ebinalg']    = 'POW'
        bkgmodel['emin']       = 1.0
        bkgmodel['emax']       = 100.0
        bkgmodel['enumbins']   = 8
        bkgmodel['ebingamma']  = 1.1
        bkgmodel['runwise']    = True
        bkgmodel['rad']        = 2.0
        bkgmodel['chatter']    = 2
        bkgmodel['outmodel']   = 'csbkgmodel_py5.xml'
        bkgmodel['logfile']    = 'csbkgmodel_py5.log'

        # Execute csbkgmodel script
        bkgmodel.logFileOpen()   # Make sure we get a log file
        bkgmodel.execute()

        # Check background model
        self._check_bkg_model('csbkgmodel_py5.xml', nmodels=2)

        # Test GAUSS(E) spatial model
        bkgmodel = cscripts.csbkgmodel()
        bkgmodel['inobs']      = self._events
        bkgmodel['caldb']      = self._caldb
        bkgmodel['irf']        = self._irf
        bkgmodel['instrument'] = 'CTA'
        bkgmodel['spatial']    = 'GAUSS(E)'
        bkgmodel['snumbins']   = 2
        bkgmodel['smin']       = 1.0
        bkgmodel['smax']       = 10.0
        bkgmodel['gradient']   = True
        bkgmodel['spectral']   = 'NODES'
        bkgmodel['ebinalg']    = 'LOG'
        bkgmodel['emin']       = 1.0
        bkgmodel['emax']       = 100.0
        bkgmodel['enumbins']   = 8
        bkgmodel['runwise']    = True
        bkgmodel['rad']        = 2.0
        bkgmodel['chatter']    = 2
        bkgmodel['outmodel']   = 'csbkgmodel_py6.xml'
        bkgmodel['logfile']    = 'csbkgmodel_py6.log'

        # Run csbkgmodel script and save background model
        bkgmodel.logFileOpen()   # Make sure we get a log file
        bkgmodel.execute()

        # Check background model
        self._check_bkg_model('csbkgmodel_py6.xml')

        # Test LOOKUP spatial model
        bkgmodel = cscripts.csbkgmodel()
        bkgmodel['inobs']      = self._events
        bkgmodel['caldb']      = self._caldb
        bkgmodel['irf']        = self._irf
        bkgmodel['instrument'] = 'CTA'
        bkgmodel['spatial']    = 'LOOKUP'
        bkgmodel['slufile']    = self._lookup
        bkgmodel['gradient']   = True
        bkgmodel['spectral']   = 'NODES'
        bkgmodel['ebinalg']    = 'LOG'
        bkgmodel['emin']       = 1.0
        bkgmodel['emax']       = 100.0
        bkgmodel['enumbins']   = 8
        bkgmodel['runwise']    = True
        bkgmodel['rad']        = 2.0
        bkgmodel['chatter']    = 2
        bkgmodel['outmodel']   = 'csbkgmodel_py7.xml'
        bkgmodel['logfile']    = 'csbkgmodel_py7.log'

        # Run csbkgmodel script and save background model
        bkgmodel.logFileOpen()   # Make sure we get a log file
        bkgmodel.execute()

        # Check background model
        self._check_bkg_model('csbkgmodel_py7.xml')

        # Test PROFILE spatial model
        bkgmodel = cscripts.csbkgmodel()
        bkgmodel['inobs']      = self._events
        bkgmodel['caldb']      = self._caldb
        bkgmodel['irf']        = self._irf
        bkgmodel['instrument'] = 'CTA'
        bkgmodel['spatial']    = 'PROFILE'
        bkgmodel['gradient']   = True
        bkgmodel['spectral']   = 'NODES'
        bkgmodel['ebinalg']    = 'LOG'
        bkgmodel['emin']       = 1.0
        bkgmodel['emax']       = 100.0
        bkgmodel['enumbins']   = 8
        bkgmodel['runwise']    = True
        bkgmodel['rad']        = 2.0
        bkgmodel['chatter']    = 2
        bkgmodel['outmodel']   = 'csbkgmodel_py8.xml'
        bkgmodel['logfile']    = 'csbkgmodel_py8.log'

        # Run csbkgmodel script and save background model
        bkgmodel.logFileOpen()   # Make sure we get a log file
        bkgmodel.execute()

        # Check background model
        self._check_bkg_model('csbkgmodel_py8.xml')

        # Test POLYNOM spatial model
        bkgmodel = cscripts.csbkgmodel()
        bkgmodel['inobs']      = self._events
        bkgmodel['caldb']      = self._caldb
        bkgmodel['irf']        = self._irf
        bkgmodel['instrument'] = 'CTA'
        bkgmodel['spatial']    = 'POLYNOM'
        bkgmodel['gradient']   = True
        bkgmodel['spectral']   = 'NODES'
        bkgmodel['ebinalg']    = 'LOG'
        bkgmodel['emin']       = 1.0
        bkgmodel['emax']       = 100.0
        bkgmodel['enumbins']   = 8
        bkgmodel['runwise']    = True
        bkgmodel['rad']        = 2.0
        bkgmodel['chatter']    = 2
        bkgmodel['outmodel']   = 'csbkgmodel_py9.xml'
        bkgmodel['logfile']    = 'csbkgmodel_py9.log'

        # Run csbkgmodel script and save background model
        bkgmodel.logFileOpen()   # Make sure we get a log file
        bkgmodel.execute()

        # Check background model
        self._check_bkg_model('csbkgmodel_py9.xml')

        # Return
        return

    # Test csbkgmodel pickeling
    def _test_pickeling(self):
        """
        Test csbkgmodel pickeling
        """
        # Perform pickeling tests of empty class
        self._pickeling(cscripts.csbkgmodel())

        # Set-up csbkgmodel
        bkgmodel = cscripts.csbkgmodel()
        bkgmodel['inobs']      = self._events
        bkgmodel['caldb']      = self._caldb
        bkgmodel['irf']        = self._irf
        bkgmodel['instrument'] = 'CTA'
        bkgmodel['spatial']    = 'GAUSS'
        bkgmodel['gradient']   = True
        bkgmodel['spectral']   = 'NODES'
        bkgmodel['ebinalg']    = 'LOG'
        bkgmodel['emin']       = 1.0
        bkgmodel['emax']       = 100.0
        bkgmodel['enumbins']   = 8
        bkgmodel['runwise']    = True
        bkgmodel['rad']        = 2.0
        bkgmodel['chatter']    = 2
        bkgmodel['outmodel']   = 'csbkgmodel_py1_pickle.xml'
        bkgmodel['logfile']    = 'csbkgmodel_py1_pickle.log'

        # Perform pickeling tests of filled class
        obj = self._pickeling(bkgmodel)

        # Run csbkgmodel script and save background model
        obj.logFileOpen()   # Make sure we get a log file
        obj.run()
        obj.save()

        # Check background model
        self._check_bkg_model('csbkgmodel_py1_pickle.xml')

        # Return
        return

    # Check background model
    def _check_bkg_model(self, filename, nmodels=1):
        """
        Check background model
        """
        # Load model
        models = gammalib.GModels(filename)

        # Check model size
        self.test_value(models.size(), nmodels,
                        'Check for %d model(s) in XML file' % nmodels)

        # Return
        return