Use "BKG" instead of "BGD" for CTA background column (#2343)

Jürgen Knödlseder
1 parent 992b421e
Showing 8 changed files with 97 additions and 13 deletions
ChangeLog
NEWS
doc/source/admin/release_history/1.5.3.rst
doc/source/admin/release_history/index.rst
inst/cta/src/GCTABackground3D.cpp
inst/cta/src/GCTAResponseIrf.cpp
inst/cta/src/GCTASupport.cpp
inst/cta/src/GCTASupport.hpp
+2019-04-23
+
+        * Bug fix version 1.5.3 released
+        ================================
+
+        Use "BKG" instead of "BGD" for CTA background column (#2343)
+
+
 2018-04-26
         * Bug fix version 1.5.2 released
-New Features and Important Changes in GammaLib 1.5.2
+New Features and Important Changes in GammaLib 1.5.3
-26 April 2018
+23 April 2019
 1. Introduction
@@ -123,9 +123,7 @@ None
 20. CTA interface
 -----------------
-The number of internal spectral nodes was not computed correctly in
-GCTABackground3D::init_mc_cache(), and hence energies could be simulated by the
-Monte Carlo method that fell outside the valid energy interval (#2462).
+Use "BKG" instead of "BGD" for CTA background column (#2343).
 21. COMPTEL interface
+.. _1.5.3:
+
+GammaLib 1.5.3 release (23 April 2019)
+======================================
+
+Overview
+--------
+
+GammaLib 1.5.3 is a bug fix release for GammaLib release 1.5.
+
+The following bugs were fixed:
+
+* [`2343 <https://cta-redmine.irap.omp.eu/issues/2343>`_] -
+  Use ``BKG`` instead of ``BGD`` for CTA background column
@@ -6,6 +6,7 @@ Release History
 .. toctree::
    :maxdepth: 1
+   GammaLib 1.5.3 <1.5.3>
    GammaLib 1.5.2 <1.5.2>
    GammaLib 1.5.1 <1.5.1>
    GammaLib 1.5 <1.5>
 /***************************************************************************
  *              GCTABackground3D.cpp - CTA 3D background class             *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2014-2017 by Juergen Knoedlseder                         *
+ *  copyright (C) 2014-2019 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -36,6 +36,7 @@
 #include "GFits.hpp"
 #include "GFitsBinTable.hpp"
 #include "GCTABackground3D.hpp"
+#include "GCTASupport.hpp"
 /* __ Method name definitions ____________________________________________ */
 #define G_READ                          "GCTABackground3D::read(GFitsTable&)"
@@ -321,7 +322,7 @@ GCTABackground3D* GCTABackground3D::clone(void) const
  *     DETY_HI  - DETY upper bin boundaries
  *     ENERG_LO - Energy lower bin boundaries
  *     ENERG_HI - Energy upper bin boundaries
- *     BGD      - Background template
+ *     BKG      - Background template (or BGD as legacy column name)
  *
  * The data are stored in the m_background member. The DETX and DETY axes
  * will be set to radians, the energy axis will be set to log10.
@@ -348,7 +349,12 @@ void GCTABackground3D::read(const GFitsTable&amp; table)
     m_inx_detx   = m_background.axis("DETX");
     m_inx_dety   = m_background.axis("DETY");
     m_inx_energy = m_background.axis("ENERG");
-    m_inx_bgd    = m_background.table("BGD");
+    if (m_background.has_table("BKG")) {
+        m_inx_bgd = m_background.table("BKG");
+    }
+    else {
+        m_inx_bgd = m_background.table("BGD"); // Old name, should not be used
+    }
     // Get axes dimensions
     m_num_detx   = m_background.axis_bins(m_inx_detx);
@@ -408,9 +414,15 @@ void GCTABackground3D::load(const GFilename&amp; filename)
     // Open FITS file
     GFits fits(filename);
+    // Get the default extension name. If no GADF compliant name was found
+    // then set the default extension name to "BACKGROUND".
+    std::string extname = gammalib::gadf_hduclas4(fits, "BKG_3D");
+    if (extname.empty()) {
+        extname = gammalib::extname_cta_background3d;
+    }
+
     // Get background table
-    const GFitsTable& table =
-          *fits.table(filename.extname(gammalib::extname_cta_background3d));
+    const GFitsTable& table = *fits.table(filename.extname(extname));
     // Read effective area from table
     read(table);
 /***************************************************************************
  *       GCTAResponseIrf.cpp - CTA instrument response function class      *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2010-2017 by Juergen Knoedlseder                         *
+ *  copyright (C) 2010-2019 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
 /***************************************************************************
  *                  GCTASupport.cpp - CTA support functions                *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2011-2017 by Juergen Knoedlseder                         *
+ *  copyright (C) 2011-2019 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -34,6 +34,7 @@
 #include "GCTASupport.hpp"
 #include "GTools.hpp"
 #include "GMath.hpp"
+#include "GFits.hpp"
 #include "GFitsHDU.hpp"
 #include "GEbounds.hpp"
 #include "GPhases.hpp"
@@ -394,3 +395,50 @@ std::string gammalib::read_ds_gti_extname(const GFitsHDU&amp; hdu)
     // Return
     return extname;
 }
+
+
+/***********************************************************************//**
+ * @brief Return extension name for GADF response table of given HDU class 4
+ *
+ * @param[in] fits FITS file.
+ * @param[in] hduclas4 HDU class 4.
+ * @return Extension name.
+ *
+ * Returns the extension name for GADF response table of given HDU class 4.
+ * If the response table is not found, an empty extension name is returned.
+ ***************************************************************************/
+std::string gammalib::gadf_hduclas4(const GFits&       fits,
+                                    const std::string& hduclas4)
+{
+    // Initialise extension name
+    std::string extname;
+
+    // Loop over all FITS HDUs
+    for (int i = 0; i < fits.size(); ++i) {
+
+        // Get FITS HDU
+        const GFitsHDU* hdu = fits[i];
+
+        // Skip HDU if it has no "HDUCLASS", "HDUCLAS1" and "HDUCLAS4" keywords
+        if (!(hdu->has_card("HDUCLASS") &&
+              hdu->has_card("HDUCLAS1") &&
+              hdu->has_card("HDUCLAS4"))) {
+            continue;
+        }
+
+        // Skip HDU if "HDUCLASS" is not "GADF", "HDUCLAS1" is not response
+        // and "HDUCLAS4" is not hduclas4
+        if (!((gammalib::strip_whitespace(hdu->string("HDUCLASS")) == "GADF") &&
+              (gammalib::strip_whitespace(hdu->string("HDUCLAS1")) == "RESPONSE") &&
+              (gammalib::strip_whitespace(hdu->string("HDUCLAS4")) == hduclas4))) {
+            continue;
+        }
+
+        // Extract extension name and break
+        extname = hdu->extname();
+
+    } // endfor: loop over headers
+
+    // Return
+    return extname;
+}
 /***************************************************************************
  *                  GCTASupport.hpp - CTA support functions                *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2011-2017 by Juergen Knoedlseder                         *
+ *  copyright (C) 2011-2019 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -36,6 +36,7 @@
 /* __ Constants __________________________________________________________ */
 /* __ Forward declarations _______________________________________________ */
+class GFits;
 class GFitsHDU;
 class GCTARoi;
 class GEbounds;
@@ -50,6 +51,8 @@ namespace gammalib {
     GEbounds    read_ds_ebounds(const GFitsHDU& hdu);
     GPhases     read_ds_phase(const GFitsHDU& hdu);
     std::string read_ds_gti_extname(const GFitsHDU& hdu);
+    std::string gadf_hduclas4(const GFits&       fits,
+                              const std::string& hduclas4);
 }
 #endif /* GCTASUPPORT_HPP */