Add max_iter parameter to ctbutterfly, cterror, ctlike, cttsmap, ctulimit and cstsmapsplit

Jürgen Knödlseder
1 parent ffa29eec
Showing 10 changed files with 38 additions and 2 deletions
ChangeLog
NEWS
cscripts/cstsmapsplit.par
doc/source/admin/release_history/1.6.rst
doc/source/users/reference_manual/ctbutterfly.rst
doc/source/users/reference_manual/ctlike.rst
doc/source/users/reference_manual/cttsmap.rst
src/ctbutterfly/ctbutterfly.par
src/ctlike/ctlike.par
src/cttsmap/cttsmap.par
-2018-12-12
+2018-01-15
         * Version 1.6.0 released
         ========================
+        Add max_iter parameter to ctbutterfly, cterror, ctlike, cttsmap,
+          ctulimit and cstsmapsplit
         ctbkgcube now requires an input counts cube (#2763)
         CTA background rates are now per ontime (#2758)
         Add exclusion_map() methods to ctskymap, csphagen, cslightcrv and
 New Features and Important Changes in ctools 1.6.0
-12 December 2018
+15 January 2019
 Introduction
@@ -99,6 +99,9 @@ normalisation is correct (#2685).
 ctbutterfly - Generate butterfly diagrams
 -----------------------------------------
+Add hidden "max_iter" parameter to allow control of the number of fit
+iterations.
+
 Add hidden "like_accuracy" parameter to allow control of the accuracy of
 the maximum log-likelikelihood value (#2662).
@@ -115,6 +118,9 @@ None
 cterror - Likelihood profile error computation
 ----------------------------------------------
+Add hidden "max_iter" parameter to allow control of the number of fit
+iterations.
+
 Add hidden "like_accuracy" parameter to allow control of the accuracy of
 the maximum log-likelikelihood value (#2662).
@@ -134,6 +140,9 @@ in the time domain (#2713).
 ctlike - Maximum likelihood fitting
 -----------------------------------
+Add hidden "max_iter" parameter to allow control of the number of fit
+iterations.
+
 Add hidden "like_accuracy" parameter to allow control of the accuracy of
 the maximum log-likelikelihood value (#2662).
@@ -225,12 +234,18 @@ accurately computes the distances between sky map pixels (#2309).
 cttsmap - Generation of Test Statistic map
 ------------------------------------------
+Add hidden "max_iter" parameter to allow control of the number of fit
+iterations.
+
 Add hidden "like_accuracy" parameter to allow control of the accuracy of
 the maximum log-likelikelihood value (#2662).
 ctulimit - Compute upper limit
 ------------------------------
+Add hidden "max_iter" parameter to allow control of the number of fit
+iterations.
+
 Add hidden "like_accuracy" parameter to allow control of the accuracy of
 the maximum log-likelikelihood value (#2662).
@@ -458,6 +473,9 @@ None
 cstsmapsplit - Prepare split Test Statistic computation
 -------------------------------------------------------
+Add hidden "max_iter" parameter to allow control of the number of fit
+iterations.
+
 Add hidden "like_accuracy" parameter to allow control of the accuracy of
 the maximum log-likelikelihood value (#2662).
@@ -29,6 +29,7 @@ edisp,         b, h, no,,, &quot;Apply energy dispersion?&quot;
 errors,        b, h, no,,, "Compute/store parameter errors?"
 statistic,     s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic"
 like_accuracy, r, h, 0.005,1.0e-30,1.0, "Absolute accuracy of maximum likelihood value"
+max_iter,      i, h, 50,1,1000, "Maximum number of fit iterations"
 outmap,        f, a, tsmap.fits,,, "Output Test Statistic map file"
 bins_per_job,  i, a, 5,,, "Number of TS map bins per task"
 compute_null,  b, a, yes,,,"Compute null hypothesis first?"
@@ -44,6 +44,9 @@ Bug fixes
 Improvements
 ------------
+* Add ``max_iter`` parameter to :ref:`ctbutterfly`, :ref:`cterror`,
+  :ref:`ctlike`, :ref:`cttsmap`, :ref:`ctulimit`, and :ref:`cstsmapsplit`
+  to allow controlling the maximum number of fit iterations.
 * [`2763 <https://cta-redmine.irap.omp.eu/issues/2763>`_] -
   :ref:`ctbkgcube` now requires an input counts cube
 * [`2725 <https://cta-redmine.irap.omp.eu/issues/2725>`_] -
@@ -100,6 +100,9 @@ General parameters
     log likelihood value. Converserly, decreasing the value will result in less
     iterations at the expense of a less accurate maximum likelihood value.
+``(max_iter = 50) [integer]``
+    Maximum number of fit iterations.
+
 ``(matrix = "NONE") [file]``
     Input covariance matrix file (not used)
@@ -111,6 +111,9 @@ General parameters
     log likelihood value. Converserly, decreasing the value will result in less
     iterations at the expense of a less accurate maximum likelihood value.
+``(max_iter = 50) [integer]``
+    Maximum number of fit iterations.
+
 ``(fix_spat_for_ts = no) [boolean]``
     Fix spatial parameters for TS computation.
@@ -80,6 +80,9 @@ General parameters
     log likelihood value. Converserly, decreasing the value will result in less
     iterations at the expense of a less accurate maximum likelihood value.
+``(max_iter = 50) [integer]``
+    Maximum number of fit iterations.
+
 ``(usepnt = no) [boolean]``
     Use CTA pointing direction for map centre instead of xref/yref parameters?
@@ -36,6 +36,7 @@ fit,           b, h, no,,, &quot;Perform maximum likelihood fitting?&quot;
 confidence,    r, h, 0.68,0.0,1.0, "Confidence level"
 statistic,     s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic"
 like_accuracy, r, h, 0.005,1.0e-30,1.0, "Absolute accuracy of maximum likelihood value"
+max_iter,      i, h, 50,1,1000, "Maximum number of fit iterations"
 matrix,        f, h, NONE,,, "Input covariance Matrix FITS file"
 #
@@ -34,6 +34,7 @@ outcovmat, f, h, NONE,,, &quot;Output covariance matrix FITS file&quot;
 statistic,       s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic"
 refit,           b, h, no,,, "Do refitting?"
 like_accuracy,   r, h, 0.005,1.0e-30,1.0, "Absolute accuracy of maximum likelihood value"
+max_iter,        i, h, 50,1,1000, "Maximum number of fit iterations"
 fix_spat_for_ts, b, h, no,,, "Fix spatial parameters for TS computation?"
 #
@@ -34,6 +34,7 @@ outmap,    f, a, tsmap.fits,,, &quot;Output Test Statistic map file&quot;
 errors,        b, h, no,,, "Compute and store parameter errors?"
 statistic,     s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic"
 like_accuracy, r, h, 0.005,1.0e-30,1.0, "Absolute accuracy of maximum likelihood value"
+max_iter,      i, h, 50,1,1000, "Maximum number of fit iterations"
 #
 # Spatial binning parameters