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