Simon Bonnefoy / ctools

Commit 3e9290d1fb3cf2aaada5a1ecb25d1330e280e6bb

Authored by Jürgen Knödlseder
1 parent e2f46067

Remove invisible character

Inline Side-by-side
Showing 2 changed files with 16 additions and 13 deletions
doc/source/users/reference_manual/csphagen.rst
  View file @3e9290d
... ... @@ -18,6 +18,7 @@ the OGIP format normally used in X-ray astronomy (PHA, ARF, RMF).
18 18 `See here <https://heasarc.gsfc.nasa.gov/docs/heasarc/ofwg/docs/spectra/ogip_92_007/node5.html>`__.
19 19  
20 20 The outputs are:
  21 +
21 22 1) the PHA, ARF, RMF files, either separately for each observation, or stacked
22 23 for a set of observations,
23 24 2) DS9 regions files listing the source and background regions for each
... ... @@ -48,29 +49,31 @@ General parameters
48 49 Prefix of the file name for output PHA, ARF, RMF, XML, and DS9 region files.
49 50  
50 51 ``emin [real]``
51   - Lower energy limit (TeV) if LIN or LOG binning algorithms are used.
  52 + Lower energy limit (TeV) if ``LIN`` or ``LOG`` binning algorithms are used.
52 53  
53 54 ``emax [real]``
54   - Upper energy limit (TeV) if LIN or LOG binning algorithms are used.
  55 + Upper energy limit (TeV) if ``LIN`` or ``LOG`` binning algorithms are used.
55 56  
56 57 ``enumbins [integer]``
57 58 Number of energy bins. At least 30 bins per decade are recommended for
58 59 proper evaluation of the instrument response.
59 60  
60   -``ebinalg [string]’’
61   - Energy binning algorithm: LOG - logarithmically spaced energy bins;
62   - LIN - linearly spaced energy bins; FILE - energy bounds retrieved from file.
  61 +``ebinalg [string]``
  62 + Energy binning algorithm:
  63 + ``LOG`` : logarithmically spaced energy bins;
  64 + ``LIN`` : linearly spaced energy bins;
  65 + ``FILE``: energy bounds retrieved from file.
63 66  
64 67 ``ebinfile [file]``
65   - Name of the file containing the energy bin definition if FILE algorithm
  68 + Name of the file containing the energy bin definition if ``FILE`` algorithm
66 69 is used.
67 70  
68 71 ``(srcshape = CIRCLE) [string]``
69 72 Shape of the source region.
70   - CIRCLE: circular region around given position.
  73 + ``CIRCLE``: circular region around given position.
71 74  
72 75 ``coordsys [string]``
73   - Coordinate system (CEL - celestial, GAL - galactic)
  76 + Coordinate system (``CEL`` - celestial, ``GAL`` - galactic)
74 77  
75 78 ``ra [real]``
76 79 Right Ascension of source region centre (deg)
... ... @@ -87,10 +90,10 @@ General parameters
87 90 ``rad [real]``
88 91 Radius of source region circle (deg)
89 92  
90   -``(bkgmethod = REFLECTED) [string]’’
  93 +``(bkgmethod = REFLECTED) [string]``
91 94 Method for background estimation.
92   - REFLECTED: background evaluated in regions with the same shape as source
93   - region reflected w.r.t. pointing direction for each observation.
  95 + ``REFLECTED:`` background evaluated in regions with the same shape as
  96 + source region reflected w.r.t. pointing direction for each observation.
94 97  
95 98 ``(bkgregmin = 2) [integer]``
96 99 Minimum number of background regions that are required for an observation.
... ... @@ -129,7 +132,7 @@ Standard parameters
129 132 output to the console.
130 133  
131 134 ``(mode = ql) [string]``
132   - Mode of automatic parameters (default is "ql", i.e. "query and learn").
  135 + Mode of automatic parameters (default is ``ql``, i.e. "query and learn").
133 136  
134 137 ``(logfile = csphagen.log) [filename]``
135 138 Log filename.
... ...
doc/source/users/reference_manual/index.rst
  View file @3e9290d
... ... @@ -50,7 +50,7 @@ cscripts
50 50 csobsdef --- Generates observation definition file <csobsdef>
51 51 csobsinfo --- Shows observation container content <csobsinfo>
52 52 csobsselect --- Select observations from observation definition file <csobsselect>
53   - csphagen —-- Generates PHA, ARF, RMF files based on source/background regions <csphagen>
  53 + csphagen --- Generates PHA, ARF, RMF files based on source/background regions <csphagen>
54 54 csphasecrv --- Computes phase curve <csphasecrv>
55 55 cspull --- Generates pull distribution <cspull>
56 56 csresmap --- Generates residual map <csresmap>
... ...