Domenico Tiziani / ctools

Commit 4e52869810c4431587f078a6f3623c595b6e1130

Authored by Jürgen Knödlseder
1 parent 68896b27

Correct reference documentation pages

Inline Side-by-side
Showing 6 changed files with 9 additions and 9 deletions
doc/source/users/reference_manual/csbkgmodel.rst
  View file @4e52869
... ... @@ -18,12 +18,12 @@ For the analytical 2D Gaussian function, a bilinear multiplicative background
18 18 gradient can be added using ``gradient=yes``. The spectral component can be
19 19 either a power law (``PLAW``) or a nodes function (``NODES``). The number of
20 20 nodes for the node function is controlled through the ``enumbins`` parameter.
21   -Specific node energies can be specified through the ``ebinalg`` parameter.
  21 +Specific node energies can be specified through the ``ebinfile`` parameter.
22 22  
23 23 If ``runwise=yes``, a background model component will be added for each observation
24 24 in the input observation definition XML file. The script fits the background
25 25 model to the input observation(s) to preset the background model parameters
26   -with resonable values.
  26 +with reasonable values.
27 27  
28 28 On output, :ref:`csbkgmodel` writes an model definition XML file that can be
29 29 used for model fitting. Source model components have to be added as needed.
... ...
doc/source/users/reference_manual/csebins.rst
  View file @4e52869
... ... @@ -9,7 +9,7 @@ Generates energy boundaries for stacked analysis.
9 9 Synopsis
10 10 --------
11 11  
12   -This script generates the energy bounaries for a stacked analysis by inspecting
  12 +This script generates the energy boundaries for a stacked analysis by inspecting
13 13 the variation in the effective area and the background template of the response
14 14 functions. The script takes either an observation definition XML file or a
15 15 specific instrument response function on input.
... ...
doc/source/users/reference_manual/csmodelselect.rst
  View file @4e52869
... ... @@ -9,7 +9,7 @@ Selects models from a model definition XML file.
9 9 Synopsis
10 10 --------
11 11  
12   -This script selects all models from a model definiton XML file that spatially
  12 +This script selects all models from a model definition XML file that spatially
13 13 overlap with the Region of Interests (RoIs) of a list of observations and writes
14 14 these models into a new model definition XML file. In addition to the spatial
15 15 selection, the tool allows selecting only models with a photon flux and/or a
... ...
doc/source/users/reference_manual/csobsselect.rst
  View file @4e52869
... ... @@ -9,10 +9,10 @@ Selects observations from an observation definition XML file.
9 9 Synopsis
10 10 --------
11 11  
12   -This script selects all observations from an observation definiton XML file that
  12 +This script selects all observations from an observation definition XML file that
13 13 have pointings within a specified selection region and time interval and writes
14 14 these observations into a new observation definition XML file. Possible selection
15   -regions are a circle and a box, either in Galactic or Celestial coordinates.
  15 +regions are a circle and a box, given either in Galactic or Celestial coordinates.
16 16  
17 17  
18 18 General parameters
... ...
doc/source/users/reference_manual/ctfindvar.rst
  View file @4e52869
... ... @@ -3,7 +3,7 @@
3 3 ctfindvar
4 4 =========
5 5  
6   -Search for source variability.
  6 +Searches for source variability.
7 7  
8 8  
9 9 Synopsis
... ... @@ -13,7 +13,7 @@ This tool searches for source variability by applying the On/Off method in the
13 13 time domain. The variability of sky map pixels is computed by binning the events
14 14 as function of the photon arrival time and applying the On/Off method to each
15 15 time bin, integrating the background over all the other time bins. Only bins
16   -with a variabilty significance below a given threshold, defined by the hidden
  16 +with a variability significance below a given threshold, defined by the hidden
17 17 ``threshold`` parameter, are included in the background estimate. Furthermore,
18 18 only time bins that exceed a minimum number of events, specified by the hidden
19 19 ``minoff`` parameter, are considered for the background estimate. The significance
... ...
doc/source/users/reference_manual/ctprob.rst
  View file @4e52869
... ... @@ -12,7 +12,7 @@ Synopsis
12 12 This tool computes for each event the probability that the event originates
13 13 from a one of the components of a model.
14 14  
15   -The tool takes on input an event list or an observation definiton XML file and
  15 +The tool takes on input an event list or an observation definition XML file and
16 16 appends on output to each event file columns that provide the probabilities.
17 17 The column names are formed from the model name that is prefixed with ``PROB_``.
18 18  
... ...