Merge branch 'bugfix-1.3.1' into integration

# Conflicts: # ChangeLog # NEWS # README.md # configure.ac # doc/Doxyfile # doc/source/conf.py # gammalib.pc.in # sonar-project.properties

Merge branch 'bugfix-1.3.1' into integration
# Conflicts: # ChangeLog # NEWS # README.md # configure.ac # doc/Doxyfile # doc/source/conf.py # gammalib.pc.in # sonar-project.properties
Jürgen Knödlseder
2 parents 51d7deec e13c97b5
Showing 10 changed files with 66 additions and 18 deletions
ChangeLog
doc/source/admin/download.rst
doc/source/admin/release_history/1.3.1.rst
doc/source/admin/release_history/index.rst
doc/source/develop/index.rst
doc/source/help/index.rst
include/GSkyDir.hpp
inst/cta/src/GCTAPsfKing.cpp
inst/cta/src/GCTAResponseIrf.cpp
src/sky/GSkyDir.cpp
@@ -6,6 +6,15 @@
         Add GSkyRegions::overlaps() and GSkyMap::overlaps() classes (#1980)
  
  
+2017-07-06
+
+        * Bug fix version 1.3.1 released
+        ================================
+
+        Improve caching in GSkyDir (#2148)
+        Make GCTAPsfKing save against invalid values (#2133)
+
+
 2017-06-06
  
         * Version 1.3.0 released
@@ -17,6 +17,9 @@ The latest GammaLib release is
 `gammalib-1.3.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.3.0.tar.gz>`_
 (7 Juin 2017).
  
+Below a table of older GammaLib releases. Please read the :ref:`sec_release` to
+learn more about new features and corrected bugs in a given release.
+
 To download an older release, click on the corresponding release number:
 `1.2.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.2.0.tar.gz>`_
 `1.1.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.1.0.tar.gz>`_
+.. _1.3.1:
+
+GammaLib 1.3.1 release
+======================
+
+Overview
+--------
+
+GammaLib 1.3.1 is a bug fix for GammaLib release 1.3.
+
+The following bugs have been fixed:
+
+* [`2133 <https://cta-redmine.irap.omp.eu/issues/2133>`_] -
+  Make GCTAPsfKing save against invalid values
+
+
+The following improvements have been made:
+
+* [`2148 <https://cta-redmine.irap.omp.eu/issues/2148>`_] -
+  Improve caching in GSkyDir
-.. _release:
+.. _sec_release:
  
 Release History
 ===============
@@ -19,6 +19,7 @@ Bug fix releases:
 .. toctree::
    :maxdepth: 1
  
+   GammaLib 1.3.1 <1.3.1>
    GammaLib 1.0.1 <1.0.1>
  
 For older GammaLib versions see
-.. _develop:
+.. _sec_develop:
  
 Developer documentation
 =======================
-.. _help:
+.. _sec_help:
  
 Getting Help
 ============
 /***************************************************************************
  *                     GSkyDir.hpp - Sky direction class                   *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2008-2014 by Juergen Knoedlseder                         *
+ *  copyright (C) 2008-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -101,12 +101,12 @@ private:
                double* xout, double *yout) const;
  
     // Private members
-    bool   m_has_lb;     //!< Has galactic coordinates
-    bool   m_has_radec;  //!< Has equatorial coordinates
-    double m_l;          //!< Galactic longitude in radians
-    double m_b;          //!< Galactic latitude in radians
-    double m_ra;         //!< Right Ascension in radians
-    double m_dec;        //!< Declination in radians
+    mutable bool   m_has_lb;     //!< Has galactic coordinates
+    mutable bool   m_has_radec;  //!< Has equatorial coordinates
+    double         m_l;          //!< Galactic longitude in radians
+    double         m_b;          //!< Galactic latitude in radians
+    double         m_ra;         //!< Right Ascension in radians
+    double         m_dec;        //!< Declination in radians
  
     // Sincos cache
     #if defined(G_SINCOS_CACHE)
@@ -518,7 +518,7 @@ double GCTAPsfKing::delta_max(const double&amp; logE,
     if (m_par_norm > 0.0) {
         radius = r_max(logE, theta);
     }
-    
+
     // Return maximum PSF radius
     return radius;
 }
@@ -760,6 +760,12 @@ void GCTAPsfKing::update(const double&amp; logE, const double&amp; theta) const
  
             } // endif: restricted PSF radius
  
+            // If maximum PSF radius is zero then also set the normalization
+            // to zero
+            else if (m_par_rmax == 0.0) {
+                m_par_norm = 0.0;
+            }
+
         } // endif: King profile parameters were valid
  
     } // endif: PSF parameters have changed
@@ -780,7 +786,8 @@ void GCTAPsfKing::update(const double&amp; logE, const double&amp; theta) const
  * is set by this method to where the containment fraction become 99.9%.
  *
  * This method requires the m_par_gamma and m_par_sigma to be set to valid
- * values.
+ * values. In case that the parameters lead to an infinite result the method
+ * will return a maximum size of zero.
  ***************************************************************************/
 double GCTAPsfKing::r_max(const double& logE,
                           const double& theta) const
@@ -791,7 +798,8 @@ double GCTAPsfKing::r_max(const double&amp; logE,
     // Compute maximum PSF radius for containment fraction
     double u_max  = (std::pow((1.0 - F), (1.0/(1.0-m_par_gamma))) - 1.0) *
                      m_par_gamma;
-    double radius = m_par_sigma * std::sqrt(2.0 * u_max);
+    double radius = (gammalib::is_infinite(u_max)) ? 0.0 :
+                     m_par_sigma * std::sqrt(2.0 * u_max);
  
     // Return maximum PSF radius
     return radius;
@@ -2075,10 +2075,11 @@ double GCTAResponseIrf::npsf(const GSkyDir&amp;      srcDir,
                 std::cout << "*** ERROR: GCTAResponseIrf::npsf:";
                 std::cout << " NaN/Inf encountered";
                 std::cout << " (value=" << value;
-                std::cout << ", roi_radius=" << roi_radius;
-                std::cout << ", roi_psf_distance=" << roi_psf_distance;
-                //std::cout << ", sigma=" << sigma;
-                std::cout << ", r=[" << rmin << "," << rmax << "])";
+                std::cout << ", roi_radius=" << roi_radius * gammalib::rad2deg;
+                std::cout << ", roi_psf_distance=";
+                std::cout << roi_psf_distance * gammalib::rad2deg;
+                std::cout << ", r=[" << rmin * gammalib::rad2deg;
+                std::cout << "," << rmax * gammalib::rad2deg << "])";
                 std::cout << std::endl;
             }
             #endif
 /***************************************************************************
  *                     GSkyDir.cpp - Sky direction class                   *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2008-2013 by Juergen Knoedlseder                         *
+ *  copyright (C) 2008-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -811,6 +811,9 @@ void GSkyDir::equ2gal(void) const
     // Convert from equatorial to galactic
     euler(0, m_ra, m_dec, l, b);
  
+    // Signal that galactic coordinates are available
+    m_has_lb = true;
+
     // Return
     return;
 }
@@ -830,6 +833,9 @@ void GSkyDir::gal2equ(void) const
     // Convert from galactic to equatorial
     euler(1, m_l, m_b, ra, dec);
  
+    // Signal that equatorial coordinates are available
+    m_has_radec = true;
+
     // Return
     return;
 }