Add units to reference manual of response cube tools (#3321)

Jürgen Knödlseder
1 parent a08eeedf
Showing 8 changed files with 27 additions and 23 deletions
ChangeLog
NEWS
README.md
doc/source/admin/release_history/1.7.1.rst
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
-2020-07-20
+2020-08-19
  
         * Bug fix version 1.7.1 released
         ================================
  
+        Add units to reference manual of response cube tools (#3321)
         Speed-up ctbin for stacked event binning (#3275)
  
  
 New Features and Important Changes in ctools 1.7.1
  
-20 July 2020
+19 August 2020
  
  
 Introduction
@@ -16,7 +16,7 @@ None
  
 Documentation
 -------------
-None
+The units of the response cubes were added to the reference manual (#3321).
  
  
 Python interface
 ctools information
 ==================
-* Version:             1.7.1 (29 May 2019)
+* Version:             1.7.1 (19 August 2019)
 * GammaLib dependency: 1.7.1
  
 [![Build Status](https://cta-jenkins.irap.omp.eu/buildStatus/icon?job=ctools-integrate-os)](https://cta-jenkins.irap.omp.eu/job/ctools-integrate-os/)
 .. _1.7.1:
  
-ctools 1.7.1 release (20 July 2020)
-===================================
+ctools 1.7.1 release (19 August 2020)
+=====================================
  
 Overview
 --------
@@ -10,8 +10,8 @@ ctools 1.7.1 is a bug fix release for ctools release 1.7.
  
 The following bugs were fixed:
  
-* ...
-
+* [`3321 <https://cta-redmine.irap.omp.eu/issues/3321>`_] -
+  Add units to reference manual of response cube tools
  
 The following improvements were done:
  
@@ -24,8 +24,9 @@ the ``incube`` parameter.
  
 :ref:`ctbkgcube` generates a background cube FITS file comprising two extensions.
 The primary extension contains a 3-dimensional image that contains the 
-background cube values. The next extension named ``EBOUNDS`` contains a
-binary table that defines the energy boundaries of the background cube.
+background cube values. The values are in units of MeV**(-1) s**(-1) sr**(-1).
+The next extension named ``EBOUNDS`` contains a binary table that defines the
+energy boundaries of the background cube.
  
 :ref:`ctbkgcube` generates also an output model XML file that can serve as input 
 for a maximum likelihood analysis. The output model XML file is a copy of
@@ -30,11 +30,11 @@ value of ``binsz=1.0``).
  
 :ref:`ctedispcube` generates an energy dispersion cube FITS file comprising three
 extensions. The primary extension contains a 4-dimensional image that contains
-the energy disperison values. The next extension named ``ENERGIES`` contains
-a binary table that defines the energies of the energy dispersion cube. The
-last extension named ``MIGRAS`` contains a binary table that defines the
-migration values of the cube which is the ratio between reconstructed and true
-photon energy.
+the energy disperison values. The values are in units of MeV**(-1). The next
+extension named ``ENERGIES`` contains a binary table that defines the energies of
+the energy dispersion cube. The last extension named ``MIGRAS`` contains a binary
+table that defines the migration values of the cube which is the ratio between
+reconstructed and true photon energy.
  
  
 General parameters
@@ -38,10 +38,11 @@ well sampled (in particular at low energies).
  
 :ref:`ctexpcube` generates an exposure cube FITS file comprising three extensions.
 The primary extension contains a 3-dimensional image that contains the 
-exposure values. The next extension named ``ENERGIES`` contains a binary table
-that defines the energies of the exposure cube. The last extension named ``GTI``
-contains a binary table that provides the Good Time Intervals of all
-observations that have been used for the computation of the exposure cube.
+exposure values. The values are in units of cm**2 s. The next extension named
+``ENERGIES`` contains a binary table that defines the energies of the exposure
+cube. The last extension named ``GTI`` contains a binary table that provides the
+Good Time Intervals of all observations that have been used for the computation
+of the exposure cube.
  
  
 General parameters
@@ -30,10 +30,11 @@ manageable (with a typical value of ``binsz=1.0``).
  
 :ref:`ctpsfcube` generates a point spread function cube FITS file comprising three
 extensions. The primary extension contains a 4-dimensional image that contains
-the point spread function values. The next extension named ``ENERGIES`` contains
-a binary table that defines the energies of the point spread function cube.
-The last extension named ``DELTAS`` contains a binary table that defines the
-offset angles between true and measured arrival direction of the photon.
+the point spread function values. The values are in units of sr**(-1). The next
+extension named ``ENERGIES`` contains a binary table that defines the energies of
+the point spread function cube. The last extension named ``DELTAS`` contains a
+binary table that defines the offset angles between true and measured arrival
+direction of the photon.
  
  
 General parameters