Rename ctlike "stat" parameter to "statistic" (#2238)

Jürgen Knödlseder
1 parent 14063948
Showing 7 changed files with 31 additions and 32 deletions
ChangeLog
NEWS
doc/source/admin/release_history/1.5.rst
doc/source/users/reference_manual/ctlike.rst
src/ctlike/ctlike.cpp
src/ctlike/ctlike.par
test/data/workflow.xml
-2017-10-18
+2017-10-21
         * Version 1.5.0 released
         ========================
+        Rename ctlike "stat" parameter to "statistic" (#2237)
         Enable handling of On/Off observations in csspec (#2231)
         Add csphagen script (#2208)
         Add RING background method to ctskymap (#2207)
 New Features and Important Changes in ctools 1.5.0
-18 October 2017
+21 October 2017
 Introduction
@@ -43,7 +43,7 @@ None
 ctlike - Maximum likelihood fitting
 -----------------------------------
-None
+Rename "stats" parameter to "statistic" (#2238).
 cttsmap - Generation of Test Statistic map
@@ -44,3 +44,9 @@ New features
   Add :ref:`csmodelsois` script
 * [`1864 <https://cta-redmine.irap.omp.eu/issues/1864>`_] -
   Use t-type parameters for all ``tmin`` and ``tmax`` parameters
+
+Clean up
+--------
+
+* [`2237 <https://cta-redmine.irap.omp.eu/issues/2237>`_] -
+  Rename :ref:`ctlike` ``stat`` parameter to ``statistic``
@@ -94,8 +94,8 @@ General parameters
 ``(outcovmat = NONE) [string]``
     Output FITS or CSV file to store covariance matrix.
-``(stat = POISSON) [string]``
-    Fitting statistics (POISSON or GAUSSIAN; only affects binned analysis).
+``(statistic = POISSON) [string]``
+    Fitting statistics (``POISSON`` or ``GAUSSIAN``; only affects binned analysis).
 ``(refit = no) [boolean]``
     Perform refitting of solution after initial fit.
@@ -379,15 +379,7 @@ void ctlike::save(void)
  * @brief Get application parameters
  *
  * Get all required task parameters from the parameter file or (if specified)
- * by querying the user. Observation dependent parameters will only be read
- * if the observation container is actually empty. Observation dependent
- * parameters are:
- * "stat" (statistic to be used for observation),
- * "caldb" (calibration database),
- * "irf" (instrument response function), and
- * "infile" (input file name).
- * The model will only be loaded if no model components exist in the
- * observation container.
+ * by querying the user.
  *
  * This method handles both loading of FITS files and of handling XML
  * observation definition files.
@@ -401,7 +393,7 @@ void ctlike::get_parameters(void)
     if (!m_use_xml) {
         // Get other task parameters
-        std::string statistic = gammalib::toupper((*this)["stat"].string());
+        std::string statistic = gammalib::toupper((*this)["statistic"].string());
         // Set statistic
         (*m_obs[0]).statistic(statistic);
@@ -31,7 +31,7 @@ outcovmat, f, h, &quot;NONE&quot;,,, &quot;Output covariance matrix FITS file&quot;
 #
 # Maximisation parameters
 #========================
-stat,            s, h, "POISSON",,, "Optimization statistics"
+statistic,       s, h, "POISSON",,, "Optimization statistics"
 refit,           b, h, no,,, "Do refitting?"
 fix_spat_for_ts, b, h, no,,, "Fix spatial parameters for TS computation?"
@@ -75,22 +75,22 @@
     </actor>
     <actor name="ctlike" tool="ctlike">
         <input>
-            <parameter name="inobs"   value="outobs"  actor="ctselect" />
-            <parameter name="inmodel" value="inmodel" actor="input" />
-            <parameter name="expcube" value="NONE" />
-            <parameter name="psfcube" value="NONE" />
-            <parameter name="bkgcube" value="NONE" />
-            <parameter name="caldb"   value="caldb" actor="input" />
-            <parameter name="irf"     value="irf"   actor="input" />
-            <parameter name="edisp"   value="edisp" actor="input" />
-            <parameter name="stat"    value="POISSON" />
-            <parameter name="edisp"   value="no" />
-            <parameter name="refit"   value="no" />
-            <parameter name="chatter" value="chatter" actor="input" />
-            <parameter name="clobber" value="clobber" actor="input" />
-            <parameter name="debug"   value="debug" actor="input" />
-            <parameter name="mode"    value="mode" actor="input" />
-            <parameter name="logfile" value="ctlike.log" />
+            <parameter name="inobs"     value="outobs"  actor="ctselect" />
+            <parameter name="inmodel"   value="inmodel" actor="input" />
+            <parameter name="expcube"   value="NONE" />
+            <parameter name="psfcube"   value="NONE" />
+            <parameter name="bkgcube"   value="NONE" />
+            <parameter name="caldb"     value="caldb" actor="input" />
+            <parameter name="irf"       value="irf"   actor="input" />
+            <parameter name="edisp"     value="edisp" actor="input" />
+            <parameter name="statistic" value="POISSON" />
+            <parameter name="edisp"     value="no" />
+            <parameter name="refit"     value="no" />
+            <parameter name="chatter"   value="chatter" actor="input" />
+            <parameter name="clobber"   value="clobber" actor="input" />
+            <parameter name="debug"     value="debug" actor="input" />
+            <parameter name="mode"      value="mode" actor="input" />
+            <parameter name="logfile"   value="ctlike.log" />
         </input>
         <output>
             <parameter name="outmodel" value="wf_crab_results.xml" />