From 10e2fb17660a2afc12719d0e8e9cc651adc668af Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Tue, 9 Feb 2016 17:52:05 +0100 Subject: [PATCH] Correct typos in reference manual. --- doc/source/reference_manual/cspull.rst | 2 +- doc/source/reference_manual/cssens.rst | 2 +- doc/source/reference_manual/csspec.rst | 2 +- doc/source/reference_manual/ctexpcube.rst | 29 ++++++++++++++++------------- doc/source/reference_manual/ctlike.rst | 14 +++++++------- doc/source/reference_manual/ctpsfcube.rst | 2 +- doc/source/reference_manual/cttsmap.rst | 2 +- doc/source/reference_manual/ctulimit.rst | 2 +- 8 files changed, 29 insertions(+), 26 deletions(-) diff --git a/doc/source/reference_manual/cspull.rst b/doc/source/reference_manual/cspull.rst index 45300de..c477682 100644 --- a/doc/source/reference_manual/cspull.rst +++ b/doc/source/reference_manual/cspull.rst @@ -11,7 +11,7 @@ Synopsis This script generates pull distributions for all free model parameters. The pull is defined as the fitted model parameter value minus the true -value, devided by the parameter error. cspull will perform ``ntrials`` +value, divided by the parameter error. cspull will perform ``ntrials`` statistically independent Monte Carlo simulations followed by maximum likelihood model fitting to derive the pull distribution for each free model parameter. If the model fit is unbiased and the parameters are diff --git a/doc/source/reference_manual/cssens.rst b/doc/source/reference_manual/cssens.rst index aa372a7..f9aa459 100644 --- a/doc/source/reference_manual/cssens.rst +++ b/doc/source/reference_manual/cssens.rst @@ -31,7 +31,7 @@ containing the sensitivity as function of energy. The first row is a header row providing the column names. The following rows provide the mean logarithmic energy and the boundaries of the energy bin for which the sensitivity was computed. They also provide the flux within the energy bin -in Crab units, in photons (ph/cm2/s) and in energy (ers/cm2/s). Finally, +in Crab units, in photons (ph/cm2/s) and in energy (erg/cm2/s). Finally, the sensitivity is given as the test source spectrum evaluated at the mean logarithmic energy multiplied by the energy squared (erg/cm2/s). diff --git a/doc/source/reference_manual/csspec.rst b/doc/source/reference_manual/csspec.rst index 08ed1f1..a4df063 100644 --- a/doc/source/reference_manual/csspec.rst +++ b/doc/source/reference_manual/csspec.rst @@ -16,7 +16,7 @@ source of interest (hidden parameter ``fix_srcs``) or to fix the background model component(s) (hidden parameter ``fix_bkg``). The script computes the source flux and its uncertainty in each spectral bin, as well as the significance of the source detection. Optionally, it also computes an upper -flux limit that is particularily useful in case that the source is not +flux limit that is particularly useful in case that the source is not significantly detected within a spectral bin (hidden parameter ``calc_ulim``). The script works on binned and unbinned data. diff --git a/doc/source/reference_manual/ctexpcube.rst b/doc/source/reference_manual/ctexpcube.rst index 3a7252a..b776c44 100644 --- a/doc/source/reference_manual/ctexpcube.rst +++ b/doc/source/reference_manual/ctexpcube.rst @@ -18,24 +18,27 @@ may be either linear, logarithmic, or custom defined using an input file. ctexpcube requires on input the event list or observation definition file that has been used in the generation of the counts cube using :doc:`ctbin`. -For the user's convenience, the counts cube can be specified as ``incube`` -parameter which will instruct ctexpcube to extract the exposure cube -definition (such as sky coordinates and projection, number of pixels, pixel -scale, energy binning) from the counts cube. Note, however, that the exposure -cube is defined in true sky coordinates and energy while the counts cube is -defined in measured sky coordinates and energy. Consequently, the sky area -and energy range covered by the exposure cube should be slightly larger than -that of the counts cube to accomodate for spill over of events due to the -point spread function and energy dispersion. By computing the exposure map -on the same grid as the counts cube, the spill over of events from sources at -the edge of cube will not be handled correctly. +The binning of an exposure cube does not need to correspond to the binning +of a counts cube, as exposure values will in any case be determined by linear +interpolation. For the user's convenience, howver, the counts cube can be +specified as ``incube`` parameter which will instruct ctexpcube to extract +the exposure cube definition (such as sky coordinates and projection, number +of pixels, pixel scale, energy binning) from the counts cube. Note, however, +that the exposure cube is defined in true sky coordinates and energy while +the counts cube is defined in measured sky coordinates and energy. Consequently, +the sky area and energy range covered by the exposure cube should be slightly +larger than that of the counts cube to accommodate for spill over of events +due to the point spread function and energy dispersion. By computing the +exposure cube on the same grid as the counts cube, the spill over of events +from sources at the edge of cube will not be handled correctly. 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 ``EBOUNDS`` contains a binary table that defines the energy boundaries of the exposure cube. The last extension -named ``GTI`` contains a binary table that defines the Good Time Intervals -of the exposure cube. +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 diff --git a/doc/source/reference_manual/ctlike.rst b/doc/source/reference_manual/ctlike.rst index e6fd8fb..94f9887 100644 --- a/doc/source/reference_manual/ctlike.rst +++ b/doc/source/reference_manual/ctlike.rst @@ -30,7 +30,7 @@ response function (parameters ``caldb`` and ``irf``). Multiple observations, including data collected with different instruments, can be handled by specifying an observation definition file on input. Each of -the observations will be kept separatly and associated with its appropriate +the observations will be kept separately and associated with its appropriate instrument response functions, as opposed to a stacked analysis where average response functions, computed using :doc:`ctexpcube`, :doc:`ctpsfcube` and :doc:`ctbkgcube`, are used. If an observation definition file is provided, ctlike will use the @@ -38,12 +38,12 @@ joint likelihood of all the observations for parameter optimisation. By default, ctlike will use the Poisson statistics for likelihood computation, but for binned analysis also Gaussian statistics can be specified (parameter -``stat``). Optionally, a refit can be done after an initial fit (parameter ``refit``), -but normally this is not needed. For all model components that have the -``tscalc="1"`` attribute set, ctlike will also compute the Test Statistics -value that is a measure of the source significance. Optionally, the spatial -model parameters can be kept fixed during that computation (parameter -``fix_spat_for_ts``). +``stat``). Optionally, a refit can be requested after an initial fit (parameter +``refit``), but normally this is not needed. For all model components that +have the ``tscalc="1"`` attribute set, ctlike will also compute the Test +Statistics value that is a measure of the source significance. Optionally, +the spatial model parameters can be kept fixed during that computation +(parameter ``fix_spat_for_ts``). ctlike generates an output model XML file that contains the values of the best fitting model parameters. For all free parameters, an ``error`` attribute diff --git a/doc/source/reference_manual/ctpsfcube.rst b/doc/source/reference_manual/ctpsfcube.rst index 0bfb195..c3c5537 100644 --- a/doc/source/reference_manual/ctpsfcube.rst +++ b/doc/source/reference_manual/ctpsfcube.rst @@ -24,7 +24,7 @@ cube definition, although this is formally possibly by specifying the counts cube as ``incube`` parameter. This leads however to a large FITS file on output since the number of bins in the counts cube will be multiplied by the number of offset angle bins (typically 200). Since the point spread -function varies only little over the field of fiew of the camera it is +function varies only little over the field of view of the camera it is recommended to use a rather coarse spatial binning to keep the file size manageable (with a typical value of ``binsz=1.0``). diff --git a/doc/source/reference_manual/cttsmap.rst b/doc/source/reference_manual/cttsmap.rst index add5a9a..b52e37b 100644 --- a/doc/source/reference_manual/cttsmap.rst +++ b/doc/source/reference_manual/cttsmap.rst @@ -16,7 +16,7 @@ each direction the TS value for the model. The TS value is defined as twice the difference between the log-likelihood obtained for the full model (including the specified source) and the log-likelihood obtained for a model that excludes the specified source. The square-root of the TS values -corresponds roughly to the pre-trial detection signifiance of the source (in +corresponds roughly to the pre-trial detection significance of the source (in Gaussian sigma). cttsmap generates a FITS file comprising a sky map of TS values followed by diff --git a/doc/source/reference_manual/ctulimit.rst b/doc/source/reference_manual/ctulimit.rst index 29e52ad..1964c39 100644 --- a/doc/source/reference_manual/ctulimit.rst +++ b/doc/source/reference_manual/ctulimit.rst @@ -9,7 +9,7 @@ Computes upper flux limit for a source model. Synopsis -------- -This tools computes the upper flux limit for a specific source model. Except +This tool computes the upper flux limit for a specific source model. Except of the node function, all spectral models are supported. Starting from the maximum likelihood model parameters, the tool finds the model flux that leads to a decrease of the likelihood that corresponds to a given confidence level. -- libgit2 0.21.4