Set "addbounds" parameters default to "no" (#1819)

Jürgen Knödlseder
1 parent 24b91e5b
Showing 11 changed files with 76 additions and 186 deletions
ChangeLog
NEWS
README.md
doc/source/users/reference_manual/ctbkgcube.rst
doc/source/users/reference_manual/ctedispcube.rst
doc/source/users/reference_manual/ctexpcube.rst
doc/source/users/reference_manual/ctpsfcube.rst
src/ctbkgcube/ctbkgcube.par
src/ctedispcube/ctedispcube.par
src/ctexpcube/ctexpcube.par
src/ctpsfcube/ctpsfcube.par
-2016-07-24  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+2016-07-28
+
+        * Version 1.2.0 released
+        ========================
+
+        Set "addbounds" parameters by default to "no" (#1819)
+
+
+2016-07-24
         * Version 1.1.0 released
         ========================
@@ -30,7 +38,7 @@
         Support out of source builds (#1484)
-2016-01-27  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+2016-01-27
         * Bug fix version 1.0.1 released
         ================================
@@ -40,7 +48,7 @@
         Change diffuse map for science verification
-2015-12-18  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+2015-12-18
         * Version 1.0.0 released
         ========================
@@ -56,7 +64,7 @@
         Resolve Python test problem on El Capitan (#1563)
-2015-10-31  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+2015-10-31
         * Version 0.10.0 released
         =========================
@@ -75,7 +83,7 @@
         Move cscripts into the ctools Python module (#1470)
-2015-05-22  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+2015-05-22
         * Version 0.9.0 released
         ========================
@@ -94,7 +102,7 @@
         Correct sensitivity computation in cssens
-2015-01-08  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+2015-01-08
         * Bug fix version 0.8.1 released
         ================================
@@ -102,7 +110,7 @@
         Include Python wrappers in source code distribution
-2014-11-08  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+2014-11-08
         * Version 0.8.0 released
         ========================
@@ -129,7 +137,7 @@
         Enhance documentation
-2014-02-20  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+2014-02-20
         * Bug fix Version 0.7.2 released
         ================================
@@ -138,7 +146,7 @@
         Properly close temporary file in ctselect (#1149)
-2014-02-05  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+2014-02-05
         * Bug fix Version 0.7.1 released
         ================================
@@ -149,7 +157,7 @@
         Use reworked GCaldb for calibration data access (#1116)
-2014-01-18  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+2014-01-18
         * Version 0.7.0 released
         ========================
@@ -164,7 +172,7 @@
         Update parameter files if necessary
-2012-12-21  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+2012-12-21
         * Version 0.6.0 released
         ========================
@@ -174,14 +182,16 @@
         Adapt to GammaLib-00-07-00 interface
         Correct ctobssim usage of seed value
-2012-10-11  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+
+2012-10-11
         * Bug fix version 0.5.2 released
         ================================
         Correct gcc 4.2.x OpenMP dlopen() test
-2012-09-18  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+
+2012-09-18
         * Bug fix version 0.5.1 released
         ================================
@@ -193,7 +203,8 @@
         Improve Python bindings configuration
         Add TEST_ENV_DIR to load library path
-2012-09-14  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+
+2012-09-14
         * Version 0.5.0 released
         ========================
@@ -202,7 +213,8 @@
         Improve logging information for ctlike
         Add OpenPM support
-2012-03-08  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+
+2012-03-08
         * Version 0.4.0 released
         ========================
@@ -219,7 +231,7 @@
         Improve building of Python bindings
-2011-10-06  Juergen Knoedlseder  <knodlseder@cesr.fr>
+2011-10-06
         * Version 0.3.0 released
         ========================
@@ -227,7 +239,7 @@
         Renamed to ctools
-2011-10-03  Juergen Knoedlseder  <knodlseder@cesr.fr>
+2011-10-03
         * Version 0.2.5 released
         ========================
@@ -237,7 +249,8 @@
         Add examples directory
         Add scripts directory
-2011-07-20  Juergen Knoedlseder  <knodlseder@cesr.fr>
+
+2011-07-20
         * Version 0.2.4 released
         ========================
@@ -245,14 +258,16 @@
         Improve configure script
         Add scripts for ctatools environment setting
-2011-07-09  Juergen Knoedlseder  <knodlseder@cesr.fr>
+
+2011-07-09
         * Version 0.2.3 released
         ========================
         Improve configure script
-2011-02-24  Juergen Knoedlseder  <knodlseder@cesr.fr>
+
+2011-02-24
         * Version 0.2.1 released
         ========================
@@ -260,7 +275,8 @@
         Correct test environment
         Adjust Python wrapper compile option on Darwin
-2011-02-21  Juergen Knoedlseder  <knodlseder@cesr.fr>
+
+2011-02-21
         * Version 0.2.0 released
         ========================
@@ -269,7 +285,8 @@
         Add unit test (make check)
         Add html documentation
-2011-02-02  Juergen Knoedlseder  <knodlseder@cesr.fr>
+
+2011-02-02
         * Version 0.1.0 released
         ========================
-New Features and Important Changes in ctools 1.1.0
+New Features and Important Changes in ctools 1.2.0
-24 July 2016
+28 July 2016
 Introduction
@@ -11,229 +11,102 @@ ctools release with respect to the precedent release.
 Configuration
 -------------
-The package now supports out of source builds (#1484).
+None
 Python interface
 ----------------
-The IACT scripts csfindobs, csiactcopy, csiactdata, and csiactobs are only
-imported into the cscripts module and tested if the Python version is 2.6 or
-newer. These scripts make use of the json Python module that is only became
-available from Python 2.6 on.
+None
 Support model
 -------------
-The "edispcube" parameter is expected in any tool that supports stacked
-analysis. If the parameter is not "NONE" or empty, the ctool::set_obs_response()
-method will load the energy dispersion cube and use it in the response
-definition of the first observations (#1724).
-
-A new method setup_observations() has been added that sets up an observation
-container by appending all required information that is missing using the
-user parameters.
+None
 ctobssim - CTA observation simulation
 -------------------------------------
-The simulation energy range is subdivided internally to avoid having a too
-large difference between simulation area and effective area. Before, there
-was a simulation area of 19634954 m^2 that was applied to all energies, which
-led to the simulation of a huge number of low energy photons that were thrown
-away later due to the small effective area. Now, the energy range is subdivided
-(controlled using the "eslices" parameter), and for each energy range, the
-simulation area is computed from the maximum effective area in that energy
-range multiplied by a security factor of 2. This leads to a much more efficient
-simulation of low-energy events (#1673).
-
-Any existing events in an event list are now removed before starting the
-simulation to enable providing an existing event file on input from which
-only the observation attributes are extracted (for example GTI, ROI, energy
-range, etc.) while the measured events are replaced by the simulated ones
-(#1663).
+None
 ctselect - CTA event selection
 ------------------------------
-The tool now allows the usage of non-default extension names for the event
-and Good Time Intervals. If the events are not located in the "EVENTS"
-extension, the extension name can be provided by appending the extension
-name to the input file name using the syntax
-
-    <filename>[<event extension name>]
-
-where <filename> needs to be replaced by the name of the FITS file and
-<event extension name> by the name of the FITS extension. ctselect also
-extracts the name of the Good Time Intervals extension from the data sub-
-space keywords provided in the header of the event file.
-
-The user has now also the possibility to specify other extension names for
-the events and the Good Time intervals upon writing of the selected output
-file. The format of the "outobs" parameter for this is
-
-    <filename>[<event extension name;GTI extension name>]
-
-If only an event extension name is provided using
-
-    <filename>[<event extension name>]
-
-the original extension name will be kept for the GTIs. Changing only the
-GTI extension name can be achieved using
-
-    <filename>[;GTI extension name>]
-
-The ctselect tool now can also write the output into the same file that
-was input, replacing the initial event (and eventually also Good Time
-Intervals) extensions.
+None
 ctbin - CTA event binning
 -------------------------
-Add publish() method to publish the counts cube via a SAMP Hub to Virtual
-Observatory interoperable tools (e.g. Aladin).
-
-The tool now computes the counts cube weights according to the overlaps
-between the Region of Interests and energy boundaries with the counts
-cube bins (#1789). Initially an implementation was done taking into account
-the partial overlaps between counts cube bins and the data space selection,
-but this led to a bias that was inherent to the method (#1819). It was
-therefore decided to move back to the original scheme.
+None
 ctlike - Maximum likelihood fitting
 -----------------------------------
-Add "edispcube" parameter to support energy dispersion for stacked analysis
-(#1724).
+None
 cttsmap - Generation of Test Statistic map
 ------------------------------------------
-Add publish() method to publish the Test Statistic map via a SAMP Hub to
-Virtual Observatory interoperable tools (e.g. Aladin).
-
-Add "edispcube" parameter to support energy dispersion for stacked analysis 
-(#1724).
+None
 ctskymap - CTA sky mapping
 --------------------------
-Add publish() method to publish the sky map via a SAMP Hub to Virtual
-Observatory interoperable tools (e.g. Aladin).
+None
 ctmodel - CTA counts cube modelling
 -----------------------------------
-Add publish() method to publish the model cube via a SAMP Hub to Virtual
-Observatory interoperable tools (e.g. Aladin).
-
-Add "edispcube" parameter to support energy dispersion for stacked analysis 
-(#1724).
+None
 ctexpcube - CTA exposure cube generation
 ----------------------------------------
-Add publish() method to publish the exposure cube via a SAMP Hub to
-Virtual Observatory interoperable tools (e.g. Aladin).
-
-Remove "edisp" parameter as this is parameter is not needed (#1724).
-
-Added hidden "addbounds" parameter to insert energy layers for each
-energy boundary of the input observation (#1819).
+Set hidden "addbounds" parameter by default to "no" (#1819).
 ctpsfcube - CTA point spread function cube generation
 -----------------------------------------------------
-Remove "edisp" parameter as this is parameter is not needed (#1724).
-
-Added hidden "addbounds" parameter to insert energy layers for each
-energy boundary of the input observation (#1819).
+Set hidden "addbounds" parameter by default to "no" (#1819).
 ctedispcube - CTA energy dispersion cube generation
 ---------------------------------------------------
-This tool generates an energy dispersion cube for a stacked analysis. The
-energy dispersion cube holds the migration matrix as function of sky
-direction, true photon energy and the migration value which is the ratio
-of reconstructed over true energy (#1724).
-
-Added hidden "addbounds" parameter to insert energy layers for each
-energy boundary of the input observation (#1819).
+Set hidden "addbounds" parameter by default to "no" (#1819).
 ctbkgcube - CTA background cube generation
 ------------------------------------------
-Add publish() method to publish the background cube via a SAMP Hub to
-Virtual Observatory interoperable tools (e.g. Aladin).
-
-Added hidden "addbounds" parameter to insert energy layers for each
-energy boundary of the input observation (#1819).
+Set hidden "addbounds" parameter by default to "no" (#1819).
 ctmapcube - CTA map cube generation
 -----------------------------------
-This tools generates a map cube from a model definition XML file. In that
-way an arbitrary source model can be fed as diffuse map cube into an
-analysis. This speeds up considerably the analysis in case that many
-(extended) sources should be kept fixed (#1760)
+None
 ctcubemask - CTA cube filtering
 -------------------------------
-Add publish() method to publish the masked counts cube via a SAMP Hub
-to Virtual Observatory interoperable tools (e.g. Aladin).
+None
 ctbutterfly - Generate butterfly diagrams
 -----------------------------------------
-Add "edispcube" parameter to support energy dispersion for stacked analysis
-(#1724).
+None
 ctulimit - Compute upper limit
 ------------------------------
-Add "edispcube" parameter to support energy dispersion for stacked analysis
-(#1724).
-
-In case that the parameter error is zero, the parameter value is taken as
-parameter error to define the bracketing parameter values (#1795).
+None
 cterror - Likelihood profile error computation
 ----------------------------------------------
-The output filename is now read ahead in case that the tool is executed
-(#1700).
-
-Add "edispcube" parameter to support energy dispersion for stacked analysis
-(#1724).
-
-
-cscripts
---------
-Add the csiactcopy script that copies IACT data from a remote machine to
-the user's machine (#1661).
-
-Add csresmap::publish() method to publish the residual map via a SAMP Hub
-to Virtual Observatory interoperable tools (e.g. Aladin).
-
-Add "edispcube" parameter to cslightcrv, csresmap, and csspec scripts to
-support energy dispersion for stacked analysis (#1724).
-
-Add csworkflow script that executes an arbitrary analysis workflow (#1508).
-
-Transformed cta_root2caldb into csroot2caldb script. The parameters
-"bgdoversample" and "bgdinfill" have been added to the parameter file to
-provide more control over the background template generation. The background
-template is now generated using linear interpolation, and the
-"bgdoversample" allows to generate the background template at a finer
-sampling than the spatial sampling in the ROOT file.
-
-Add csobsdef.pntdef() method to set directly a pointing definition from a
-gammalib.GCsv object (#1771).
+None
-Add cstsmapsplit script that generates the command sequence for splitting the
-computation of a Test Statistic map into computations of sub maps (#1797).
-Unit tests have been added for all cscripts.
+scripts
+-------
+None
 Examples
 ctools information
 ==================
-* Version:             1.2.0.dev1 (24 July 2016)
+* Version:             1.2.0.dev1 (28 July 2016)
 * Author:              Juergen Knoedlseder (jurgen.knodlseder@irap.omp.eu)
 * GammaLib dependency: 1.2.0.dev1
@@ -87,7 +87,7 @@ General parameters
 ``ebinfile [file]``
     Name of the file containing the energy bin definition.
-``(addbounds = yes) [boolean]``
+``(addbounds = no) [boolean]``
     Add energies to the background cube at the observation energy boundaries?
 ``(usepnt = no) [boolean]``
@@ -70,7 +70,7 @@ General parameters
 ``ebinfile [file]``
     Name of the file containing the energy bin definition.
-``(addbounds = yes) [boolean]``
+``(addbounds = no) [boolean]``
     Add energies to the energy dispersion cube at the observation energy boundaries?
 ``(usepnt = no) [boolean]``
@@ -77,7 +77,7 @@ General parameters
 ``ebinfile [file]``
     Name of the file containing the energy bin definition.
-``(addbounds = yes) [boolean]``
+``(addbounds = no) [boolean]``
     Add energies to the exposure cube at the observation energy boundaries?
 ``(usepnt = no) [boolean]``
@@ -69,7 +69,7 @@ General parameters
 ``ebinfile [file]``
     Name of the file containing the energy bin definition.
-``(addbounds = yes) [boolean]``
+``(addbounds = no) [boolean]``
     Add energies to the point spread function cube at the observation energy boundaries?
 ``(usepnt = no) [boolean]``
@@ -5,7 +5,7 @@
 # ------------------------------------------------------------------------- #
 #                                                                           #
 #  File:      ctbkgcube.par                                                 #
-#  Version:   1.1.0                                                         #
+#  Version:   1.2.0                                                         #
 #                                                                           #
 #  Author:    Chia-Chun Lu                                                  #
 #             c.lu@mpi-hd.mpg.de                                            #
@@ -33,7 +33,7 @@ emin,      r, a, 0.1,,, &quot;Lower energy limit (TeV)&quot;
 emax,      r, a, 100.0,,, "Upper energy limit (TeV)"
 enumbins,  i, a, 20,,, "Number of energy bins"
 ebinfile,  f, h, "NONE",,, "Name of the file containing the energy bin definition"
-addbounds, b, h, yes,,, "Add energies at observation energy boundaries?"
+addbounds, b, h, no,,, "Add energies at observation energy boundaries?"
 #
 # Spatial binning parameters
@@ -5,7 +5,7 @@
 # ------------------------------------------------------------------------- #
 #                                                                           #
 #  File:      ctedispcube.par                                               #
-#  Version:   1.1.0                                                         #
+#  Version:   1.2.0                                                         #
 #                                                                           #
 #  Author:    Maria Haupt                                                   #
 #             maria.haupt@desy.de                                           #
@@ -31,7 +31,7 @@ emin,      r, a, 0.1,,, &quot;Lower energy limit (TeV)&quot;
 emax,      r, a, 100.0,,, "Upper energy limit (TeV)"
 enumbins,  i, a, 20,,, "Number of energy bins"
 ebinfile,  f, h, "NONE",,, "Name of the file containing the energy bin definition"
-addbounds, b, h, yes,,, "Add energies at observation energy boundaries?"
+addbounds, b, h, no,,, "Add energies at observation energy boundaries?"
 #
 # Spatial binning parameters
@@ -5,7 +5,7 @@
 # ------------------------------------------------------------------------- #
 #                                                                           #
 #  File:      ctexpcube.par                                                 #
-#  Version:   1.1.0                                                         #
+#  Version:   1.2.0                                                         #
 #                                                                           #
 #  Author:    Juergen Knoedlseder                                           #
 #             Jurgen.Knodlseder@irap.omp.eu                                 #
@@ -31,7 +31,7 @@ emin,      r, a, 0.1,,,&quot;Lower energy limit (TeV)&quot;
 emax,      r, a, 100.0,,, "Upper energy limit (TeV)"
 enumbins,  i, a, 20,,, "Number of energy bins"
 ebinfile,  f, h, "NONE",,, "Name of the file containing the energy bin definition"
-addbounds, b, h, yes,,, "Add energies at observation energy boundaries?"
+addbounds, b, h, no,,, "Add energies at observation energy boundaries?"
 #
 # Spatial binning parameters
@@ -5,7 +5,7 @@
 # ------------------------------------------------------------------------- #
 #                                                                           #
 #  File:      ctpsfcube.par                                                 #
-#  Version:   1.1.0                                                         #
+#  Version:   1.2.0                                                         #
 #                                                                           #
 #  Author:    Chia-Chun Lu                                                  #
 #             c.lu@mpi-hd.mpg.de                                            #
@@ -31,7 +31,7 @@ emin,      r, a, 0.1,,, &quot;Lower energy limit (TeV)&quot;
 emax,      r, a, 100.0,,, "Upper energy limit (TeV)"
 enumbins,  i, a, 20,,, "Number of energy bins"
 ebinfile,  f, h, "NONE",,, "Name of the file containing the energy bin definition"
-addbounds, b, h, yes,,, "Add energies at observation energy boundaries?"
+addbounds, b, h, no,,, "Add energies at observation energy boundaries?"
 #
 # Spatial binning parameters