Andreas Specovius / ctools

Commit d8471eb43b9c3fcd179949dd221104d68f86232b

Authored by Luigi Tibaldo
1 parent 7cab99b1

fixed description of inexclusion plus cosmetic changes

Inline Side-by-side
Showing 4 changed files with 23 additions and 13 deletions
doc/source/users/reference_manual/cslightcrv.rst
  View file @d8471eb
@@ -62,9 +62,11 @@ General parameters @@ -62,9 +62,11 @@ General parameters
62 Instrumental response function. 62 Instrumental response function.
63 63
64 ``(inexclusion = NONE) [file]`` 64 ``(inexclusion = NONE) [file]``
65 - Optional FITS file containing a WCS map in the first hdu that defines sky  
66 - regions not to be used for background estimation in On/Off analysis (where  
67 - map value != 0). 65 + Optional FITS file containing a WCS map that defines sky regions
  66 + not to be used for background estimation (where map value !=
  67 + 0). If the file contains multiple extensions the user may specify
  68 + which one to use. Otherwise, the extention ``EXCLUSION`` will be
  69 + used if available, or else the primary extension will be used.
68 70
69 ``(edisp = no) [boolean]`` 71 ``(edisp = no) [boolean]``
70 Applies energy dispersion to response computation (for ``3D`` analysis only, 72 Applies energy dispersion to response computation (for ``3D`` analysis only,
doc/source/users/reference_manual/csphagen.rst
  View file @d8471eb
@@ -88,8 +88,11 @@ General parameters @@ -88,8 +88,11 @@ General parameters
88 Instrument response function. 88 Instrument response function.
89 89
90 ``(inexclusion = NONE) [file]`` 90 ``(inexclusion = NONE) [file]``
91 - Optional FITS file containing a WCS map in the first extension that defines  
92 - sky regions not to be used for background estimation (where map value != 0). 91 + Optional FITS file containing a WCS map that defines sky regions
  92 + not to be used for background estimation (where map value !=
  93 + 0). If the file contains multiple extensions the user may specify
  94 + which one to use. Otherwise, the extention ``EXCLUSION`` will be
  95 + used if available, or else the primary extension will be used.
93 96
94 ``outobs [file]`` 97 ``outobs [file]``
95 Output observation definition XML file. 98 Output observation definition XML file.
doc/source/users/reference_manual/csphasecrv.rst
  View file @d8471eb
@@ -59,9 +59,11 @@ General parameters @@ -59,9 +59,11 @@ General parameters
59 Instrumental response function. 59 Instrumental response function.
60 60
61 ``(inexclusion = NONE) [file]`` 61 ``(inexclusion = NONE) [file]``
62 - Optional FITS file containing a WCS map in the first hdu that defines sky  
63 - regions not to be used for background estimation in On/Off analysis (where  
64 - map value != 0). 62 + Optional FITS file containing a WCS map that defines sky regions
  63 + not to be used for background estimation (where map value !=
  64 + 0). If the file contains multiple extensions the user may specify
  65 + which one to use. Otherwise, the extention ``EXCLUSION`` will be
  66 + used if available, or else the primary extension will be used.
65 67
66 ``(edisp = no) [boolean]`` 68 ``(edisp = no) [boolean]``
67 Applies energy dispersion to response computation (for ``3D`` analysis only, 69 Applies energy dispersion to response computation (for ``3D`` analysis only,
doc/source/users/reference_manual/csscs.rst
  View file @d8471eb
@@ -87,8 +87,11 @@ General parameters @@ -87,8 +87,11 @@ General parameters
87 Instrument response function. 87 Instrument response function.
88 88
89 ``inexclusion [file]`` 89 ``inexclusion [file]``
90 - Optional FITS file containing a WCS map in the first extension that defines  
91 - sky regions not to be used for background estimation (where map value != 0). 90 + FITS file containing a WCS map that defines sky regions not to be used for
  91 + background estimation (where map value != 0). If the file
  92 + contains multiple extensions the user may specify which one
  93 + to use. Otherwise, the extention ``EXCLUSION`` will be used if
  94 + available, or else the primary extension will be used.
92 95
93 ``(edisp = no) [boolean]`` 96 ``(edisp = no) [boolean]``
94 Apply energy dispersion to response computation? 97 Apply energy dispersion to response computation?
@@ -118,12 +121,12 @@ General parameters @@ -118,12 +121,12 @@ General parameters
118 Declination / Galactic latitude of image centre (J2000, in 121 Declination / Galactic latitude of image centre (J2000, in
119 degrees). 122 degrees).
120 123
121 - ``rad [real]`` 124 +``rad [real]``
122 Radius of region of interest for component separation (deg). Sets 125 Radius of region of interest for component separation (deg). Sets
123 the correlation scale between neighbour pixels in the output maps. Must 126 the correlation scale between neighbour pixels in the output maps. Must
124 be at least sqrt(2) times ``binsz`` for full coverage of input data. 127 be at least sqrt(2) times ``binsz`` for full coverage of input data.
125 128
126 - ``emin [real]`` 129 +``emin [real]``
127 Minimum energy (in TeV). 130 Minimum energy (in TeV).
128 131
129 ``emax [real]`` 132 ``emax [real]``
@@ -152,7 +155,7 @@ General parameters @@ -152,7 +155,7 @@ General parameters
152 On/Off analysis. If this number of background regions is not available the 155 On/Off analysis. If this number of background regions is not available the
153 observation is skipped. 156 observation is skipped.
154 157
155 - ``(bkgregskip = 1) [integer]`` 158 +``(bkgregskip = 1) [integer]``
156 Number of background regions that should be skipped next to the On regions. 159 Number of background regions that should be skipped next to the On regions.
157 Typically, one region is skipped so that the Off regions are taken sufficiently 160 Typically, one region is skipped so that the Off regions are taken sufficiently
158 distant from the On region, but in some cases it may be useful to keep the 161 distant from the On region, but in some cases it may be useful to keep the