Change CTA 3D background "BGD" keywords to "BKG" (#2343)

Jürgen Knödlseder
1 parent df193cc3
Showing 16 changed files with 90 additions and 94 deletions
ChangeLog
NEWS
caldb/data/cta/prod2/bcf/North_0.5h/irf_file.fits.gz
caldb/data/cta/prod2/bcf/North_50h/irf_file.fits.gz
caldb/data/cta/prod2/bcf/North_5h/irf_file.fits.gz
caldb/data/cta/prod2/bcf/South_0.5h/irf_file.fits.gz
caldb/data/cta/prod2/bcf/South_50h/irf_file.fits.gz
caldb/data/cta/prod2/bcf/South_5h/irf_file.fits.gz
caldb/data/cta/prod2/caldb.indx
cscripts/csobs2caldb.py
cscripts/csroot2caldb.py
doc/source/admin/release_history/1.6.rst
test/data/iactdata/events/irf_file.fits.gz
test/data/irf_file.fits.gz
test/dev/cta_kb_root2caldb.py
test/test_csobs2caldb.py
-2018-07-27
+2018-07-31
         * Version 1.6.0 released
         ========================
@@ -16,6 +16,7 @@
         Keep existing library path in installation script on Mac OS X (#2420)
         csphagen produces Xspec compliant data (#2404)
         Add show_rmf.py example script
+        Change CTA 3D background "BGD" keywords to "BKG" (#2343)
         Add ras() and decs() methods to csobsinfo (#2313)
         Also compute TS in csspec for On/Off analysis using wstat statistic (#2312)
         Allow specifying of input sky map in ctskymap (#2311)
 New Features and Important Changes in ctools 1.6.0
-27 July 2018
+31 July 2018
 Introduction
@@ -226,7 +226,7 @@ None
 csobs2caldb - Generate calibration database entry for an IACT observation
 -------------------------------------------------------------------------
-None
+Change background template table name from "BGD" to "BKG" (#2343).
 csobsdef - Generate observation definition XML file
@@ -288,6 +288,8 @@ parameter due to a bug in the code. This bug was fixed (#2448).
 csroot2caldb - Generates calibration database from ROOT file
 ------------------------------------------------------------
+Change background template table name from "BGD" to "BKG" (#2343).
+
 The ROOT Python module is now imported in the run method and not globally so
 that no conflit arises with the "--help" option (#2652).
@@ -2,7 +2,7 @@
 # ==========================================================================
 # Creates a calibration database entry for an IACT observation
 #
-# Copyright (C) 2015-2017 Michael Mayer
+# Copyright (C) 2015-2018 Michael Mayer
 #
 # 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
@@ -32,7 +32,7 @@ from cscripts import calutils
 class csobs2caldb(ctools.csobservation):
     """
     Creates a calibration database entry for an IACT observation.
-    
+
     The creation of a calibration database entry is useful for performing
     simulations for current Imaging Air Cherenkov Telescopes (IACTs).
     The class takes an observation definition XML file as input and uses
@@ -40,7 +40,7 @@ class csobs2caldb(ctools.csobservation):
     the first observation will be used, but the user can specify the
     index of any observation using the hidden "index" parameter.
     """
-    
+
     # Constructor
     def __init__(self, *argv):
         """
@@ -81,7 +81,7 @@ class csobs2caldb(ctools.csobservation):
         if self.obs().is_empty():
             raise ValueError('No or empty observation provided for '
                              'parameter "inobs".')
-        
+
         # Get index of observation to be used
         index = self['index'].integer()
@@ -89,7 +89,7 @@ class csobs2caldb(ctools.csobservation):
         if index < 0 or index >= self.obs().size():
             raise IndexError('Parameter "index=%d" outside the validity '
                              'range [0,%d].' % (index, self.obs().size()))
-        
+
         # Get observation
         self._observation = self.obs()[index]
@@ -97,13 +97,13 @@ class csobs2caldb(ctools.csobservation):
         if not self._observation.classname() == 'GCTAObservation':
             raise RuntimeError('Input observation not of type '
                                '"GCTAObservation".')
-        
+
         # Make sure we have an IRF response associated with the CTA
         # observation
         if not self._observation.response().classname() == 'GCTAResponseIrf':
             raise RuntimeError('Response of input observation not of '
                                'type "GCTAResponseIrf".')
-        
+
         # Get calibration database name. If the "caldb" parameter is "NONE"
         # or empty then use the instrument name from the observation as
         # calibration database name.
@@ -132,13 +132,11 @@ class csobs2caldb(ctools.csobservation):
         Creates an IRF FITS file
         """
         # Write header into logger
-        if self._logTerse():
-            self._log("\n")
-            self._log.header2("Creating IRF file")
+        self._log_header2(gammalib.TERSE, 'Creating IRF file')
         # Get response for the observation
         rsp = self._observation.response()
-        
+
         # Extract response file names
         fname_aeff  = rsp.aeff().filename()
         fname_psf   = rsp.psf().filename()
@@ -151,7 +149,7 @@ class csobs2caldb(ctools.csobservation):
         self._log_value(gammalib.NORMAL, 'Point spread function', fname_psf.url())
         self._log_value(gammalib.NORMAL, 'Energy dispersion', fname_edisp.url())
         self._log_value(gammalib.NORMAL, 'Background rate', fname_bkg.url())
-    
+
         # Open FITS files of response components
         fits_aeff  = gammalib.GFits(fname_aeff)
         fits_psf   = gammalib.GFits(fname_psf)
@@ -163,10 +161,10 @@ class csobs2caldb(ctools.csobservation):
         ext_psf   = fname_psf.extname("POINT SPREAD FUNCTION")
         ext_edisp = fname_edisp.extname("ENERGY DISPERSION")
         ext_bkg   = fname_bkg.extname("BACKGROUND")
-        
+
         # Create empty FITS file
         fits = gammalib.GFits()
-        
+
         # Append IRF component to FITS file
         fits.append(fits_aeff[ext_aeff])
         fits.append(fits_psf[ext_psf])
@@ -186,7 +184,7 @@ class csobs2caldb(ctools.csobservation):
             self._log("\n")
             self._log(str(fits[ext_bkg].header()))
             self._log("\n")
-        
+
         # Return fits file
         return fits
@@ -195,16 +193,14 @@ class csobs2caldb(ctools.csobservation):
         Creates an IRF index FITS file
         """
         # Write header into logger
-        if self._logTerse():
-            self._log('\n')
-            self._log.header2('Creating database index file')
+        self._log_header2(gammalib.TERSE, 'Creating database index file')
         # Open calibration database index
         indx_file = self._base_dir + '/caldb.indx'
-        
+
         # Open index file (or create one if it does not exist)
         cif = gammalib.GFits(indx_file, True)
-        
+
         # Retrieve "CIF" table
         if cif.contains('CIF'):
             table = cif.table('CIF')
@@ -212,7 +208,7 @@ class csobs2caldb(ctools.csobservation):
         # ... or create binary table if no "CIF" table exists yet, append
         # binary table to CIF file and return a reference to the appended
         # table to work with
-        else:       
+        else:
             table = cif.append(calutils.create_cif_table())
         # Check if output config already exist
@@ -223,9 +219,9 @@ class csobs2caldb(ctools.csobservation):
             if caldir == self._cal_dir:
                 has_config = True
                 break
-         
-        # Create columns if not available   
-        if not has_config:           
+
+        # Create columns if not available
+        if not has_config:
             # Append 4 rows to CIF extension
             table.append_rows(4)
             row_index = table.nrows()
@@ -241,7 +237,7 @@ class csobs2caldb(ctools.csobservation):
             # Set date
             now = str(datetime.datetime.now())
             today, time = now.split()
-            
+
             # Set element
             table['TELESCOP'][row] = self._mission
             table['INSTRUME'][row] = self._caldb
@@ -268,7 +264,7 @@ class csobs2caldb(ctools.csobservation):
         row = row_index-3
         table['CAL_CNAM'][row] = 'RPSF'
         table['CAL_DESC'][row] = self._caldb+' point spread function'
-        
+
         # Add energy dispersion information
         row = row_index-2
         table['CAL_CNAM'][row] = 'EDISP'
@@ -276,7 +272,7 @@ class csobs2caldb(ctools.csobservation):
         # Add background information
         row = row_index-1
-        table['CAL_CNAM'][row] = 'BGD'
+        table['CAL_CNAM'][row] = 'BKG'
         table['CAL_DESC'][row] = self._caldb+' background'
         # Log resulting FITS table and header
@@ -286,35 +282,33 @@ class csobs2caldb(ctools.csobservation):
         if self._logExplicit():
             self._log(str(table.header()))
             self._log('\n')
-        
+
         # Return CIF FITS file
         return cif
-        
+
     def _make_dirs(self):
         """
         Make CALDB directories
         """
         # Write header into logger
-        if self._logTerse():
-            self._log("\n")
-            self._log.header2("Creating directory structure")
+        self._log_header2(gammalib.TERSE, 'Creating directory structure')
         # Create calibration database        
-        caldb = gammalib.GCaldb(self["rootdir"].string())
-        
+        caldb = gammalib.GCaldb(self['rootdir'].string())
+
         # Set calibration directory 
-        self._cal_dir  = "data"
-        self._cal_dir += "/"+self._mission.lower()
-        self._cal_dir += "/"+self._caldb.lower()
-        self._cal_dir += "/bcf/"+self["irf"].string()
-        
+        self._cal_dir  = 'data'
+        self._cal_dir += '/'+self._mission.lower()
+        self._cal_dir += '/'+self._caldb.lower()
+        self._cal_dir += '/bcf/'+self['irf'].string()
+
         # Set absolute path
-        self._base_dir = caldb.rootdir() +"/data"
-        self._base_dir += "/"+self._mission.lower()
-        self._base_dir += "/"+self._caldb.lower()
-        
+        self._base_dir = caldb.rootdir() +'/data'
+        self._base_dir += '/'+self._mission.lower()
+        self._base_dir += '/'+self._caldb.lower()
+
         # Set directory for irf file
-        self._rsp_dir = caldb.rootdir() + "/" + self._cal_dir
+        self._rsp_dir = caldb.rootdir() + '/' + self._cal_dir
         # Log resulting FITS table
         self._log_value(gammalib.NORMAL, 'Calibration directory', self._cal_dir)
@@ -324,7 +318,7 @@ class csobs2caldb(ctools.csobservation):
         else:
             name = 'IRF directory (existing)'
         self._log_value(gammalib.NORMAL, name, self._rsp_dir)
-        
+
         # Create IRF directory is it does not yet exist
         if not os.path.isdir(self._rsp_dir):
             os.makedirs(self._rsp_dir)
@@ -344,21 +338,19 @@ class csobs2caldb(ctools.csobservation):
         # Get parameters
         self._get_parameters()
-        
+
         # Write input parameters and header into logger
-        if self._logTerse():
-            self._log('\n')
-            self._log.header1('Creating CALDB entry')
-        
+        self._log_header1(gammalib.TERSE, 'Creating CALDB entry')
+
         # Create directory structure
         self._make_dirs()
-         
+
         # Create/update calibration database   
         self._caldb_inx = self._make_caldb_index()
-        
+
         # Create response file
         self._irf_fits = self._make_irf_file()
-                
+
         # Return
         return
@@ -371,7 +363,7 @@ class csobs2caldb(ctools.csobservation):
         # Set response filename
         filename = self._rsp_dir + '/' + self._outfile
-        
+
         # Write filenames into logger
         self._log_value(gammalib.NORMAL, 'CALDB index file',
                         self._caldb_inx.filename().url())
@@ -382,7 +374,7 @@ class csobs2caldb(ctools.csobservation):
         # Save response file
         self._irf_fits.saveto(filename, self._clobber())
-        
+
         # Return
         return
@@ -394,6 +386,6 @@ if __name__ == &#39;__main__&#39;:
     # Create instance of application
     app = csobs2caldb(sys.argv)
-    
+
     # Execute application
     app.execute()
@@ -130,12 +130,12 @@ class csroot2caldb(ctools.cscript):
         irf['EDISP_DOC']      = '???'
         irf['EDISP_BOUNDS']   = copy.deepcopy(cal_bounds)
         irf['EDISP_DESC']     = 'CTA energy dispersion'
-        irf['BGD_NAME']       = 'BKG'
-        irf['BGD_HDUCLAS3']   = 'FULL-ENCLOSURE'
-        irf['BGD_HDUCLAS4']   = '3D'
-        irf['BGD_DOC']        = '???'
-        irf['BGD_BOUNDS']     = copy.deepcopy(cal_bounds)
-        irf['BGD_DESC']       = 'CTA background'
+        irf['BKG_NAME']       = 'BKG'
+        irf['BKG_HDUCLAS3']   = 'FULL-ENCLOSURE'
+        irf['BKG_HDUCLAS4']   = '3D'
+        irf['BKG_DOC']        = '???'
+        irf['BKG_BOUNDS']     = copy.deepcopy(cal_bounds)
+        irf['BKG_DESC']       = 'CTA background'
         # Set parameter dependent IRF information
         if self['psftype'].string() == 'King':
@@ -183,7 +183,7 @@ class csroot2caldb(ctools.cscript):
         ds['EA_DIR']    = obs_dir
         ds['PSF_DIR']   = obs_dir
         ds['EDISP_DIR'] = obs_dir
-        ds['BGD_DIR']   = obs_dir
+        ds['BKG_DIR']   = obs_dir
         # Set path to response components. If the "outdir" parameter is set
         # then prefix the value to the path of the response components
@@ -193,13 +193,13 @@ class csroot2caldb(ctools.cscript):
             ds['EA_PATH']    = outdir+'/'+ds['EA_DIR']
             ds['PSF_PATH']   = outdir+'/'+ds['PSF_DIR']
             ds['EDISP_PATH'] = outdir+'/'+ds['EDISP_DIR']
-            ds['BGD_PATH']   = outdir+'/'+ds['BGD_DIR']
+            ds['BKG_PATH']   = outdir+'/'+ds['BKG_DIR']
         else:
             ds['BASE_PATH']  = base_dir
             ds['EA_PATH']    = ds['EA_DIR']
             ds['PSF_PATH']   = ds['PSF_DIR']
             ds['EDISP_PATH'] = ds['EDISP_DIR']
-            ds['BGD_PATH']   = ds['BGD_DIR']
+            ds['BKG_PATH']   = ds['BKG_DIR']
         # Set IRF component file names. If the "split" parameter is "yes" then
         # split the IRF components over several files.
@@ -207,12 +207,12 @@ class csroot2caldb(ctools.cscript):
             ds['EA_FILE']    = 'ea_'+version+'.fits'
             ds['PSF_FILE']   = 'psf_'+version+'.fits'
             ds['EDISP_FILE'] = 'edisp_'+version+'.fits'
-            ds['BGD_FILE']   = 'bgd_'+version+'.fits'
+            ds['BKG_FILE']   = 'bgd_'+version+'.fits'
         else:
             ds['EA_FILE']    = 'irf_'+version+'.fits'
             ds['PSF_FILE']   = 'irf_'+version+'.fits'
             ds['EDISP_FILE'] = 'irf_'+version+'.fits'
-            ds['BGD_FILE']   = 'irf_'+version+'.fits'
+            ds['BKG_FILE']   = 'irf_'+version+'.fits'
         # Create directory structure
         if not os.path.isdir(ds['EA_PATH']):
@@ -221,8 +221,8 @@ class csroot2caldb(ctools.cscript):
             os.makedirs(ds['PSF_PATH'])
         if not os.path.isdir(ds['EDISP_PATH']):
             os.makedirs(ds['EDISP_PATH'])
-        if not os.path.isdir(ds['BGD_PATH']):
-            os.makedirs(ds['BGD_PATH'])
+        if not os.path.isdir(ds['BKG_PATH']):
+            os.makedirs(ds['BKG_PATH'])
         # Return ds
         return ds
@@ -255,19 +255,19 @@ class csroot2caldb(ctools.cscript):
         ea_filename    = ds['EA_PATH']+'/'+ds['EA_FILE']
         psf_filename   = ds['PSF_PATH']+'/'+ds['PSF_FILE']
         edisp_filename = ds['EDISP_PATH']+'/'+ds['EDISP_FILE']
-        bgd_filename   = ds['BGD_PATH']+'/'+ds['BGD_FILE']
+        bgd_filename   = ds['BKG_PATH']+'/'+ds['BKG_FILE']
         # Open IRF component files
         if self['split'].boolean():
             ds['EA_FITS']    = gammalib.GFits(ea_filename, True)
             ds['PSF_FITS']   = gammalib.GFits(psf_filename, True)
             ds['EDISP_FITS'] = gammalib.GFits(edisp_filename, True)
-            ds['BGD_FITS']   = gammalib.GFits(bgd_filename, True)
+            ds['BKG_FITS']   = gammalib.GFits(bgd_filename, True)
         else:
             ds['EA_FITS']    = gammalib.GFits(ea_filename, True)
             ds['PSF_FITS']   = ds['EA_FITS']
             ds['EDISP_FITS'] = ds['EA_FITS']
-            ds['BGD_FITS']   = ds['EA_FITS']
+            ds['BKG_FITS']   = ds['EA_FITS']
         # Open HDUs
         ds['HDU_EA']    = self._open_hdu(ds['EA_FITS'], "EFFECTIVE AREA",
@@ -282,9 +282,9 @@ class csroot2caldb(ctools.cscript):
                                          irf['EDISP_NAME'], irf['EDISP_HDUCLAS3'],
                                          irf['EDISP_HDUCLAS4'], irf['EDISP_DOC'],
                                          irf)
-        ds['HDU_BGD']   = self._open_hdu(ds['BGD_FITS'], "BACKGROUND",
-                                         irf['BGD_NAME'], irf['BGD_HDUCLAS3'],
-                                         irf['BGD_HDUCLAS4'], irf['BGD_DOC'],
+        ds['HDU_BKG']   = self._open_hdu(ds['BKG_FITS'], "BACKGROUND",
+                                         irf['BKG_NAME'], irf['BKG_HDUCLAS3'],
+                                         irf['BKG_HDUCLAS4'], irf['BKG_DOC'],
                                          irf)
         # Return
@@ -318,10 +318,10 @@ class csroot2caldb(ctools.cscript):
         if self['split'].boolean():
             ds['PSF_FITS'].save(True)
             ds['EDISP_FITS'].save(True)
-            ds['BGD_FITS'].save(True)
+            ds['BKG_FITS'].save(True)
             ds['PSF_FITS'].close()
             ds['EDISP_FITS'].close()
-            ds['BGD_FITS'].close()
+            ds['BKG_FITS'].close()
         # Return
         return
@@ -421,7 +421,7 @@ class csroot2caldb(ctools.cscript):
             Directory structure dictionary
         """
         # Set list of IRF component names
-        names = ['EA', 'PSF', 'EDISP', 'BGD']
+        names = ['EA', 'PSF', 'EDISP', 'BKG']
         # Initialise CIF row index
         row = ds['HDU_CIF'].nrows()
@@ -1049,7 +1049,7 @@ class csroot2caldb(ctools.cscript):
         Translate ROOT to CALDB background extension.
         The following ROOT histograms are used:
-        - BGRatePerSqDeg_offaxis -> BGD
+        - BGRatePerSqDeg_offaxis -> BKG
         Parameters
         ----------
@@ -1081,11 +1081,11 @@ class csroot2caldb(ctools.cscript):
             self._renorm_onaxis(array, array_1D)
         # Write boundary keywords
-        self._set_cif_keywords(ds['HDU_BGD'], irf['BGD_NAME'],
-                               irf['BGD_BOUNDS'], irf['BGD_DESC'], irf)
+        self._set_cif_keywords(ds['HDU_BKG'], irf['BKG_NAME'],
+                               irf['BKG_BOUNDS'], irf['BKG_DESC'], irf)
-        # Create "BGD" data column
-        self._make_3D(array, ds['HDU_BGD'], 'BGD', '1/(MeV s sr)')
+        # Create "BKG" data column
+        self._make_3D(array, ds['HDU_BKG'], 'BKG', '1/(MeV s sr)')
         # Return
         return
@@ -42,6 +42,8 @@ Improvements
 * [`2404 <https://cta-redmine.irap.omp.eu/issues/2404>`_] -
   :ref:`csphagen` produces Xspec compliant data
 * Add ``show_rmf.py`` example script
+* [`2343 <https://cta-redmine.irap.omp.eu/issues/2343>`_] -
+  Change CTA 3D background ``BGD`` keywords to ``BKG``
 * [`2313 <https://cta-redmine.irap.omp.eu/issues/2313>`_] -
   Add `ras()` and `decs()` methods to :ref:`csobsinfo`
 * [`2312 <https://cta-redmine.irap.omp.eu/issues/2312>`_] -
@@ -7,7 +7,7 @@
 # area (i.e. the area before applying any theta cut). This is required by
 # GammaLib as the maximum likelihood analysis does not imply any theta cut.
 #
-# Copyright (C) 2014-2016 Juergen Knoedlseder
+# 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
@@ -23,7 +23,6 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # ==========================================================================
-#from ROOT import TFile, TH1F, TH2F
 from ROOT import TFile, TH1F
 from datetime import datetime
 import gammalib
@@ -96,7 +95,7 @@ class caldb():
         self.edisp_bounds = [self.cal_name, self.cal_version, self.cal_cut, self.cal_analysis]
         self.edisp_desc   = "CTA energy dispersion"
         #
-        self.bgd_name     = "BGD"
+        self.bgd_name     = "BKG"
         self.bgd_doc      = "???"
         self.bgd_bounds   = [self.cal_name, self.cal_version, self.cal_cut, self.cal_analysis]
         self.bgd_desc     = "CTA background"
@@ -34,7 +34,7 @@ class Test(test):
     This test class makes unit tests for the csobs2caldb script by using it
     from the command line and from Python.
     """
-    
+
     # Constructor
     def __init__(self):
         """
@@ -159,13 +159,13 @@ class Test(test):
         aeff  = gammalib.GFilename(db.filename('','','EFF_AREA','','',expr))
         psf   = gammalib.GFilename(db.filename('','','RPSF','','',expr))
         edisp = gammalib.GFilename(db.filename('','','EDISP','','',expr))
-        bgd   = gammalib.GFilename(db.filename('','','BGD','','',expr))
+        bkg   = gammalib.GFilename(db.filename('','','BKG','','',expr))
         # Check whether files exist
         self.test_assert(aeff.exists(), 'Effective area file exists')
         self.test_assert(psf.exists(), 'Point spread function file exists')
         self.test_assert(edisp.exists(), 'Energy dispersion file exists')
-        self.test_assert(bgd.exists(), 'Background file exists')
-        
+        self.test_assert(bkg.exists(), 'Background file exists')
+
         # Return
         return