Changed GObservation::statistics() to GObservation::statistic() (#2238)

Jürgen Knödlseder
1 parent eea337bd
Showing 13 changed files with 90 additions and 84 deletions
ChangeLog
NEWS
doc/source/admin/release_history/1.5.rst
include/GObservation.hpp
inst/com/src/GCOMObservation.cpp
inst/cta/src/GCTAObservation.cpp
inst/cta/src/GCTAOnOffObservation.cpp
inst/cta/test/test_CTA.cpp
inst/lat/src/GLATObservation.cpp
inst/mwl/src/GMWLObservation.cpp
pyext/GObservation.i
src/obs/GObservation.cpp
src/template/GXXXObservation.cpp
@@ -3,6 +3,7 @@
         * Version 1.5.0 released
         =========================
+        Changed GObservation::statistics() to statistic() (#2238)
         Prevent negative response values for COMPTEL IRF (#2234)
         Add GCTAOnOffObservation PHA, ARF and RMF constructor (#2231)
         Implement observation stacking in GCTAOnOffObservation (#2228)
@@ -84,7 +84,8 @@ The following methods have been removed:
 - n.a.
 The following methods have been renamed:
-- n.a.
+- GObservation::statistic() was GObservation::statistics()
+- GObservation::statistic(std::string&) was GObservation::statistics(std::string&)
 The arguments for the following methods have been changed:
 - GCOMResponse(GCaldb&, std::string&)
@@ -78,4 +78,6 @@ New features
 Clean up
 --------
-* None
+* [`2238 <https://cta-redmine.irap.omp.eu/issues/2238>`_] -
+  Changed ``GObservation::statistics()`` to ``GObservation::statistic()``
+
 /***************************************************************************
  *            GObservation.hpp - Abstract observation base class           *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2008-2016 by Juergen Knoedlseder                         *
+ *  copyright (C) 2008-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -115,10 +115,10 @@ public:
     // Implemented methods
     void               name(const std::string& name);
     void               id(const std::string& id);
-    void               statistics(const std::string& statistics);
+    void               statistic(const std::string& statistic);
     const std::string& name(void) const;
     const std::string& id(void) const;
-    const std::string& statistics(void) const;
+    const std::string& statistic(void) const;
 protected:
     // Protected methods
@@ -209,7 +209,7 @@ protected:
     // Protected data area
     std::string m_name;        //!< Observation name
     std::string m_id;          //!< Observation identifier
-    std::string m_statistics;  //!< Optimizer statistics (default=Poisson)
+    std::string m_statistic;  //!< Optimizer statistic (default=Poisson)
     GEvents*    m_events;      //!< Pointer to event container
 };
@@ -245,16 +245,16 @@ void GObservation::id(const std::string&amp; id)
 /***********************************************************************//**
- * @brief Set optimizer statistics
+ * @brief Set optimizer statistic
  *
- * @param[in] statistics Optimizer statistics.
+ * @param[in] statistic Optimizer statistic.
  *
- * Set optimizer statistics for the observation.
+ * Set optimizer statistic for the observation.
  ***************************************************************************/
 inline
-void GObservation::statistics(const std::string& statistics)
+void GObservation::statistic(const std::string& statistic)
 {
-    m_statistics = statistics;
+    m_statistic = statistic;
     return;
 }
@@ -284,14 +284,14 @@ const std::string&amp; GObservation::id(void) const
 /***********************************************************************//**
- * @brief Return optimizer statistics
+ * @brief Return optimizer statistic
  *
- * @return Optimizer statistics.
+ * @return Optimizer statistic.
  ***************************************************************************/
 inline
-const std::string& GObservation::statistics(void) const
+const std::string& GObservation::statistic(void) const
 {
-    return (m_statistics);
+    return (m_statistic);
 }
 #endif /* GOBSERVATION_HPP */
@@ -696,7 +696,7 @@ std::string GCOMObservation::print(const GChatter&amp; chatter) const
         result.append("\n"+gammalib::parformat("Name")+name());
         result.append("\n"+gammalib::parformat("Identifier")+id());
         result.append("\n"+gammalib::parformat("Instrument")+instrument());
-        result.append("\n"+gammalib::parformat("Statistics")+statistics());
+        result.append("\n"+gammalib::parformat("Statistic")+statistic());
         result.append("\n"+gammalib::parformat("Ontime"));
         result.append(gammalib::str(ontime())+" sec");
         result.append("\n"+gammalib::parformat("Livetime"));
@@ -1397,7 +1397,7 @@ std::string GCTAObservation::print(const GChatter&amp; chatter) const
         result.append("\n"+gammalib::parformat("Instrument")+instrument());
         result.append("\n"+gammalib::parformat("Event file")+eventfile().url());
         result.append("\n"+gammalib::parformat("Event type")+eventtype());
-        result.append("\n"+gammalib::parformat("Statistics")+statistics());
+        result.append("\n"+gammalib::parformat("Statistic")+statistic());
         result.append("\n"+gammalib::parformat("Ontime"));
         result.append(gammalib::str(ontime())+" s");
         result.append("\n"+gammalib::parformat("Livetime"));
@@ -668,7 +668,7 @@ void GCTAOnOffObservation::write(GXmlElement&amp; xml) const
  * @return Log-likelihood value.
  *
  * @exception GException::invalid_value
- *            Invalid statistics encountered.
+ *            Invalid statistic encountered.
  ***************************************************************************/
 double GCTAOnOffObservation::likelihood(const GModels& models,
                                         GVector*       gradient,
@@ -678,22 +678,22 @@ double GCTAOnOffObservation::likelihood(const GModels&amp; models,
     // Initialise likelihood value
     double value = 0.0;
-    // Extract statistics for this observation
-    std::string statistics = gammalib::toupper(this->statistics());
+    // Extract statistic for this observation
+    std::string statistic = gammalib::toupper(this->statistic());
-    // Poisson statistics with modeled background
-    if ((statistics == "POISSON") || (statistics == "CSTAT")) {
+    // Poisson statistic with modeled background
+    if ((statistic == "POISSON") || (statistic == "CSTAT")) {
         value = likelihood_cstat(models, gradient, curvature, npred);
     }
-    // ... or Poisson statistics with measured background
-    else if (statistics == "WSTAT") {
+    // ... or Poisson statistic with measured background
+    else if (statistic == "WSTAT") {
         value = likelihood_wstat(models, gradient, curvature, npred);
     }
     // ... or unsupported
     else {
-        std::string msg = "Invalid statistics \""+statistics+"\" encountered. "
+        std::string msg = "Invalid statistic \""+statistic+"\" encountered. "
                           "Either specify \"POISSON\", \"CSTAT\" or "
                           "\"WSTAT\".";
         throw GException::invalid_value(G_LIKELIHOOD, msg);
@@ -761,8 +761,8 @@ void GCTAOnOffObservation::init_members(void)
     m_rmf.clear();
     m_logetrue.clear();
-    // Overwrite base class statistics
-    m_statistics = "POISSON";
+    // Overwrite base class statistic
+    m_statistic = "Poisson";
     // Return
     return;
@@ -2005,7 +2005,7 @@ double GCTAOnOffObservation::likelihood_cstat(const GModels&amp; models,
     std::cout << "Number of bins with zero data: " << n_zero_data << std::endl;
     std::cout << "Sum of data (On): " << sum_data << std::endl;
     std::cout << "Sum of model (On): " << sum_model << std::endl;
-    std::cout << "Statistics: " << value << std::endl;
+    std::cout << "Statistic: " << value << std::endl;
     #endif
     // Optionally dump gradient and curvature matrix
@@ -231,9 +231,9 @@ void TestGCTAOptimize::set(void)
     append(static_cast<pfunction>(&TestGCTAOptimize::test_stacked_optimizer),
            "Test stacked optimizer");
     append(static_cast<pfunction>(&TestGCTAOptimize::test_onoff_optimizer_cstat),
-           "Test On/Off optimizer using CSTAT statistics");
+           "Test On/Off optimizer using CSTAT statistic");
     append(static_cast<pfunction>(&TestGCTAOptimize::test_onoff_optimizer_wstat),
-           "Test On/Off optimizer using WSTAT statistics");
+           "Test On/Off optimizer using WSTAT statistic");
     // Return
     return;
@@ -2165,9 +2165,9 @@ void TestGCTAOptimize::test_onoff_optimizer_cstat(void)
     // Load On/Off CTA observation
     GObservations obs(cta_onoff_obs);
-    // Set fit statistics
+    // Set fit statistic
     for (int i = 0; i < obs.size(); ++i){
-        obs[i]->statistics("CSTAT");
+        obs[i]->statistic("CSTAT");
     }
     // Load models from XML file
@@ -2207,9 +2207,9 @@ void TestGCTAOptimize::test_onoff_optimizer_wstat(void)
     // Load On/Off CTA observation
     GObservations obs(cta_onoff_obs);
-    // Set fit statistics
+    // Set fit statistic
     for (int i = 0; i < obs.size(); ++i){
-        obs[i]->statistics("WSTAT");
+        obs[i]->statistic("WSTAT");
     }
     // Load models from XML file
 /***************************************************************************
  *             GLATObservation.cpp - Fermi LAT observation class           *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2008-2016 by Juergen Knoedlseder                         *
+ *  copyright (C) 2008-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -502,7 +502,7 @@ void GLATObservation::write(GXmlElement&amp; xml) const
 /***********************************************************************//**
  * @brief Print LAT observation information
  *
- * @param[in] chatter Chattiness (defaults to NORMAL).
+ * @param[in] chatter Chattiness.
  * @return String containing LAT observation information.
  ***************************************************************************/
 std::string GLATObservation::print(const GChatter& chatter) const
@@ -520,7 +520,7 @@ std::string GLATObservation::print(const GChatter&amp; chatter) const
         result.append("\n"+gammalib::parformat("Name")+name());
         result.append("\n"+gammalib::parformat("Identifier")+id());
         result.append("\n"+gammalib::parformat("Instrument")+instrument());
-        result.append("\n"+gammalib::parformat("Statistics")+statistics());
+        result.append("\n"+gammalib::parformat("Statistic")+statistic());
         result.append("\n"+gammalib::parformat("Ontime"));
         result.append(gammalib::str(ontime())+" s");
         result.append("\n"+gammalib::parformat("Livetime"));
 /***************************************************************************
  *         GMWLObservation.cpp - Multi-wavelength observation class        *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2010-2016 by Juergen Knoedlseder                         *
+ *  copyright (C) 2010-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -350,7 +350,7 @@ std::string GMWLObservation::print(const GChatter&amp; chatter) const
         result.append("\n"+gammalib::parformat("Name")+name());
         result.append("\n"+gammalib::parformat("Identifier")+id());
         result.append("\n"+gammalib::parformat("Instrument")+instrument());
-        result.append("\n"+gammalib::parformat("Statistics")+statistics());
+        result.append("\n"+gammalib::parformat("Statistic")+statistic());
         // EXPLICIT: Append events
         if (chatter >=  EXPLICIT) {
@@ -386,8 +386,8 @@ void GMWLObservation::init_members(void)
     m_filename.clear();
     m_response.clear();
-    // Overwrite base class statistics
-    m_statistics = "Gaussian";
+    // Overwrite base class statistic
+    m_statistic = "Gaussian";
     // Return
     return;
 /***************************************************************************
  *             GObservation.i - Abstract observation base 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   *
@@ -94,10 +94,10 @@ public:
     // Implemented methods
     void               name(const std::string& name);
     void               id(const std::string& id);
-    void               statistics(const std::string& statistics);
+    void               statistic(const std::string& statistic);
     const std::string& name(void) const;
     const std::string& id(void) const;
-    const std::string& statistics(void) const;
+    const std::string& statistic(void) const;
 };
 /***************************************************************************
  *            GObservation.cpp - Abstract observation base class           *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2008-2016 by Juergen Knoedlseder                         *
+ *  copyright (C) 2008-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -181,14 +181,14 @@ double GObservation::likelihood(const GModels&amp; models,
     // Initialise likelihood value
     double value = 0.0;
-    // Extract statistics for this observation
-    std::string statistics = gammalib::toupper(this->statistics());
+    // Extract statistic for this observation
+    std::string statistic = gammalib::toupper(this->statistic());
     // Unbinned analysis
     if (dynamic_cast<const GEventList*>(events()) != NULL) {
-        // Poisson statistics
-        if (statistics == "POISSON") {
+        // Poisson statistic
+        if (statistic == "POISSON") {
             // Update the log-likelihood
             value = likelihood_poisson_unbinned(models,
@@ -196,12 +196,13 @@ double GObservation::likelihood(const GModels&amp; models,
                                                 curvature,
                                                 npred);
-        } // endif: Poisson statistics
+        } // endif: Poisson statistic
         // ... otherwise throw an exception
         else {
-            throw GException::invalid_statistics(G_LIKELIHOOD, statistics,
-                  "Unbinned optimization requires Poisson statistics.");
+            std::string msg = "Invalid statistic \""+statistic+"\". Unbinned "
+                              "optimization requires \"POISSON\" statistic.";
+            throw GException::invalid_value(G_LIKELIHOOD, msg);
         }
     } // endif: unbinned analysis
@@ -209,27 +210,28 @@ double GObservation::likelihood(const GModels&amp; models,
     // ... or binned analysis
     else {
-        // Poisson statistics
-        if (statistics == "POISSON") {
+        // Poisson statistic
+        if (statistic == "POISSON") {
             value = likelihood_poisson_binned(models,
                                               gradient,
                                               curvature,
                                               npred);
         }
-        // ... or Gaussian statistics
-        else if (statistics == "GAUSSIAN") {
+        // ... or Gaussian statistic
+        else if (statistic == "GAUSSIAN") {
             value = likelihood_gaussian_binned(models,
-                                              gradient,
-                                              curvature,
-                                              npred);
+                                               gradient,
+                                               curvature,
+                                               npred);
         }
         // ... or unsupported
         else {
-            throw GException::invalid_statistics(G_LIKELIHOOD, statistics,
-                  "Binned optimization requires Poisson or Gaussian"
-                  " statistics.");
+            std::string msg = "Invalid statistic \""+statistic+"\". Unbinned "
+                              "optimization requires \"POISSON\" or "
+                              "\"GAUSSIAN\" statistic.";
+            throw GException::invalid_value(G_LIKELIHOOD, msg);
         }
     } // endelse: binned analysis
@@ -833,8 +835,8 @@ void GObservation::init_members(void)
     // Initialise members
     m_name.clear();
     m_id.clear();
-    m_statistics = "Poisson";
-    m_events     = NULL;
+    m_statistic = "Poisson";
+    m_events    = NULL;
     // Return
     return;
@@ -851,9 +853,9 @@ void GObservation::init_members(void)
 void GObservation::copy_members(const GObservation& obs)
 {
     // Copy members
-    m_name       = obs.m_name;
-    m_id         = obs.m_id;
-    m_statistics = obs.m_statistics;
+    m_name      = obs.m_name;
+    m_id        = obs.m_id;
+    m_statistic = obs.m_statistic;
     // Clone members
     m_events = (obs.m_events != NULL) ? obs.m_events->clone() : NULL;
@@ -886,7 +888,7 @@ void GObservation::free_members(void)
  ==========================================================================*/
 /***********************************************************************//**
- * @brief Evaluate log-likelihood function for Poisson statistics and
+ * @brief Evaluate log-likelihood function for Poisson statistic and
  *        unbinned analysis (version with working arrays)
  *
  * @param[in] models Models.
@@ -896,7 +898,7 @@ void GObservation::free_members(void)
  * @return Likelihood value.
  *
  * This method evaluates the -(log-likelihood) function for parameter
- * optimisation using unbinned analysis and Poisson statistics.
+ * optimisation using unbinned analysis and Poisson statistic.
  * The -(log-likelihood) function is given by
  *
  * \f[
@@ -960,7 +962,7 @@ double GObservation::likelihood_poisson_unbinned(const GModels&amp; models,
             }
         }
-        // Update Poissonian statistics (excluding factorial term for faster
+        // Update Poissonian statistic (excluding factorial term for faster
         // computation)
         value -= log(model);
@@ -1006,7 +1008,7 @@ double GObservation::likelihood_poisson_unbinned(const GModels&amp; models,
 /***********************************************************************//**
- * @brief Evaluate log-likelihood function for Poisson statistics and
+ * @brief Evaluate log-likelihood function for Poisson statistic and
  *        binned analysis (version with working arrays)
  *
  * @param[in] models Models.
@@ -1016,7 +1018,7 @@ double GObservation::likelihood_poisson_unbinned(const GModels&amp; models,
  * @return Likelihood value.
  *
  * This method evaluates the -(log-likelihood) function for parameter
- * optimisation using binned analysis and Poisson statistics.
+ * optimisation using binned analysis and Poisson statistic.
  * The -(log-likelihood) function is given by
  *
  * \f[
@@ -1039,7 +1041,7 @@ double GObservation::likelihood_poisson_binned(const GModels&amp; models,
     // Initialise likelihood value
     double value = 0.0;
-    // Initialise statistics
+    // Initialise statistic
     #if defined(G_OPT_DEBUG)
     int    n_bins         = 0;
     int    n_used         = 0;
@@ -1096,7 +1098,7 @@ double GObservation::likelihood_poisson_binned(const GModels&amp; models,
             continue;
         }
-        // Update statistics
+        // Update statistic
         #if defined(G_OPT_DEBUG)
         n_used++;
         sum_data  += data;
@@ -1127,7 +1129,7 @@ double GObservation::likelihood_poisson_binned(const GModels&amp; models,
         // matrix ...
         if (data > 0.0) {
-            // Update Poissonian statistics (excluding factorial term for
+            // Update Poissonian statistic (excluding factorial term for
             // faster computation)
             value -= data * log(model) - model;
@@ -1168,12 +1170,12 @@ double GObservation::likelihood_poisson_binned(const GModels&amp; models,
         // ... handle now data=0
         else {
-            // Update statistics
+            // Update statistic
             #if defined(G_OPT_DEBUG)
             n_zero_data++;
             #endif
-            // Update Poissonian statistics (excluding factorial term for
+            // Update Poissonian statistic (excluding factorial term for
             // faster computation)
             value += model;
@@ -1196,7 +1198,7 @@ double GObservation::likelihood_poisson_binned(const GModels&amp; models,
     if (values != NULL) delete [] values;
     if (inx    != NULL) delete [] inx;
-    // Dump statistics
+    // Dump statistic
     #if defined(G_OPT_DEBUG)
     std::cout << "Number of bins: " << n_bins << std::endl;
     std::cout << "Number of bins used for computation: " << n_used << std::endl;
@@ -1205,8 +1207,8 @@ double GObservation::likelihood_poisson_binned(const GModels&amp; models,
     std::cout << "Number of bins with zero data: " << n_zero_data << std::endl;
     std::cout << "Sum of data: " << sum_data << std::endl;
     std::cout << "Sum of model: " << sum_model << std::endl;
-    std::cout << "Initial statistics: " << init_value << std::endl;
-    std::cout << "Statistics: " << m_value-init_value << std::endl;
+    std::cout << "Initial statistic: " << init_value << std::endl;
+    std::cout << "Statistic: " << m_value-init_value << std::endl;
     #endif
     // Return
@@ -1215,7 +1217,7 @@ double GObservation::likelihood_poisson_binned(const GModels&amp; models,
 /***********************************************************************//**
- * @brief Evaluate log-likelihood function for Gaussian statistics and
+ * @brief Evaluate log-likelihood function for Gaussian statistic and
  *        binned analysis (version with working arrays)
  *
  * @param[in] models Models.
@@ -1225,7 +1227,7 @@ double GObservation::likelihood_poisson_binned(const GModels&amp; models,
  * @return Likelihood value.
  *
  * This method evaluates the -(log-likelihood) function for parameter
- * optimisation using binned analysis and Poisson statistics.
+ * optimisation using binned analysis and Poisson statistic.
  * The -(log-likelihood) function is given by
  *
  * \f[
@@ -1311,7 +1313,7 @@ double GObservation::likelihood_gaussian_binned(const GModels&amp; models,
         // Set weight
         double weight = 1.0 / (sigma * sigma);
-        // Update Gaussian statistics
+        // Update Gaussian statistic
         double fa = data - model;
         value  += 0.5 * (fa * fa * weight);
@@ -304,7 +304,7 @@ std::string GXXXObservation::print(const GChatter&amp; chatter) const
         result.append("\n"+gammalib::parformat("Name")+name());
         result.append("\n"+gammalib::parformat("Identifier")+id());
         result.append("\n"+gammalib::parformat("Instrument")+instrument());
-        result.append("\n"+gammalib::parformat("Statistics")+statistics());
+        result.append("\n"+gammalib::parformat("Statistic")+statistic());
         result.append("\n"+gammalib::parformat("Ontime"));
         result.append(gammalib::str(ontime())+" sec");
         result.append("\n"+gammalib::parformat("Livetime"));