From d8471eb43b9c3fcd179949dd221104d68f86232b Mon Sep 17 00:00:00 2001 From: Luigi Tibaldo Date: Fri, 14 Feb 2020 12:26:20 +0100 Subject: [PATCH] fixed description of inexclusion plus cosmetic changes --- doc/source/users/reference_manual/cslightcrv.rst | 8 +++++--- doc/source/users/reference_manual/csphagen.rst | 7 +++++-- doc/source/users/reference_manual/csphasecrv.rst | 8 +++++--- doc/source/users/reference_manual/csscs.rst | 13 ++++++++----- 4 files changed, 23 insertions(+), 13 deletions(-) diff --git a/doc/source/users/reference_manual/cslightcrv.rst b/doc/source/users/reference_manual/cslightcrv.rst index c2ff529..5e759f7 100755 --- a/doc/source/users/reference_manual/cslightcrv.rst +++ b/doc/source/users/reference_manual/cslightcrv.rst @@ -62,9 +62,11 @@ General parameters Instrumental response function. ``(inexclusion = NONE) [file]`` - Optional FITS file containing a WCS map in the first hdu that defines sky - regions not to be used for background estimation in On/Off analysis (where - map value != 0). + Optional FITS file containing a WCS map that defines sky regions + not to be used for background estimation (where map value != + 0). If the file contains multiple extensions the user may specify + which one to use. Otherwise, the extention ``EXCLUSION`` will be + used if available, or else the primary extension will be used. ``(edisp = no) [boolean]`` Applies energy dispersion to response computation (for ``3D`` analysis only, diff --git a/doc/source/users/reference_manual/csphagen.rst b/doc/source/users/reference_manual/csphagen.rst index ce40906..296b10d 100644 --- a/doc/source/users/reference_manual/csphagen.rst +++ b/doc/source/users/reference_manual/csphagen.rst @@ -88,8 +88,11 @@ General parameters Instrument response function. ``(inexclusion = NONE) [file]`` - Optional FITS file containing a WCS map in the first extension that defines - sky regions not to be used for background estimation (where map value != 0). + Optional FITS file containing a WCS map that defines sky regions + not to be used for background estimation (where map value != + 0). If the file contains multiple extensions the user may specify + which one to use. Otherwise, the extention ``EXCLUSION`` will be + used if available, or else the primary extension will be used. ``outobs [file]`` Output observation definition XML file. diff --git a/doc/source/users/reference_manual/csphasecrv.rst b/doc/source/users/reference_manual/csphasecrv.rst index c7b4b7a..0020085 100755 --- a/doc/source/users/reference_manual/csphasecrv.rst +++ b/doc/source/users/reference_manual/csphasecrv.rst @@ -59,9 +59,11 @@ General parameters Instrumental response function. ``(inexclusion = NONE) [file]`` - Optional FITS file containing a WCS map in the first hdu that defines sky - regions not to be used for background estimation in On/Off analysis (where - map value != 0). + Optional FITS file containing a WCS map that defines sky regions + not to be used for background estimation (where map value != + 0). If the file contains multiple extensions the user may specify + which one to use. Otherwise, the extention ``EXCLUSION`` will be + used if available, or else the primary extension will be used. ``(edisp = no) [boolean]`` Applies energy dispersion to response computation (for ``3D`` analysis only, diff --git a/doc/source/users/reference_manual/csscs.rst b/doc/source/users/reference_manual/csscs.rst index 89d97ac..ec6e734 100644 --- a/doc/source/users/reference_manual/csscs.rst +++ b/doc/source/users/reference_manual/csscs.rst @@ -87,8 +87,11 @@ General parameters Instrument response function. ``inexclusion [file]`` - Optional FITS file containing a WCS map in the first extension that defines - sky regions not to be used for background estimation (where map value != 0). + FITS file containing a WCS map that defines sky regions not to be used for + background estimation (where map value != 0). If the file + contains multiple extensions the user may specify which one + to use. Otherwise, the extention ``EXCLUSION`` will be used if + available, or else the primary extension will be used. ``(edisp = no) [boolean]`` Apply energy dispersion to response computation? @@ -118,12 +121,12 @@ General parameters Declination / Galactic latitude of image centre (J2000, in degrees). - ``rad [real]`` +``rad [real]`` Radius of region of interest for component separation (deg). Sets the correlation scale between neighbour pixels in the output maps. Must be at least sqrt(2) times ``binsz`` for full coverage of input data. - ``emin [real]`` +``emin [real]`` Minimum energy (in TeV). ``emax [real]`` @@ -152,7 +155,7 @@ General parameters On/Off analysis. If this number of background regions is not available the observation is skipped. - ``(bkgregskip = 1) [integer]`` +``(bkgregskip = 1) [integer]`` Number of background regions that should be skipped next to the On regions. Typically, one region is skipped so that the Off regions are taken sufficiently distant from the On region, but in some cases it may be useful to keep the -- libgit2 0.21.4