Commit 0b0c715ddc8c7780708d06b2f07ef7c8bdeacb53
1 parent
65bcb4a1
Update reference manual
Showing
2 changed files
with
21 additions
and
13 deletions
doc/source/reference_manual/ctbutterfly.rst
| @@ -3,18 +3,19 @@ | @@ -3,18 +3,19 @@ | ||
| 3 | ctbutterfly | 3 | ctbutterfly |
| 4 | =========== | 4 | =========== |
| 5 | 5 | ||
| 6 | -Computes butterfly. | 6 | +Computes butterfly diagram for a power law model. |
| 7 | 7 | ||
| 8 | 8 | ||
| 9 | Synopsis | 9 | Synopsis |
| 10 | -------- | 10 | -------- |
| 11 | 11 | ||
| 12 | Calculates the confidence band of a power law model, taking into account the | 12 | Calculates the confidence band of a power law model, taking into account the |
| 13 | -covariance matrix of a likelihood fit. The tool derives the envelope of | ||
| 14 | -power law models with parameters that lie within the error ellipse. It | ||
| 15 | -outputs an ASCII file in column separated value (CSV) format containing | ||
| 16 | -the results. Each row in the result file corresponds to an energy. The | ||
| 17 | -columns give the energy in MeV, the fitted intensity in ph/cm2/s/MeV, | 13 | +covariance matrix resulting from a maximum likelihood fit. The tool derives |
| 14 | +the envelope of all power law models whose prefactor and spectral index fall | ||
| 15 | +within the error ellipse that is associated with the covariance of the | ||
| 16 | +parameters. It outputs an ASCII file in column separated value (CSV) format | ||
| 17 | +containing the results. Each row in the result file corresponds to an energy. | ||
| 18 | +The columns give the energy in MeV, the fitted intensity in ph/cm2/s/MeV, | ||
| 18 | and the minimum and maximum intensity that envelope the power law model | 19 | and the minimum and maximum intensity that envelope the power law model |
| 19 | with a given confidence (by default a confidence level of 68% is used, but | 20 | with a given confidence (by default a confidence level of 68% is used, but |
| 20 | the level can be adjusted using the ``confidence`` parameter). | 21 | the level can be adjusted using the ``confidence`` parameter). |
doc/source/reference_manual/ctlike.rst
| @@ -9,13 +9,20 @@ Performs binned and unbinned maximum likelihood analysis of CTA data. | @@ -9,13 +9,20 @@ Performs binned and unbinned maximum likelihood analysis of CTA data. | ||
| 9 | Synopsis | 9 | Synopsis |
| 10 | -------- | 10 | -------- |
| 11 | 11 | ||
| 12 | -Determines source model parameters, such as flux, spectral index, source | ||
| 13 | -position, and source extent from a maximum likelihood analysis of CTA data. | ||
| 14 | -The analysis can be done in a binned or an unbinned formulation of the | ||
| 15 | -log-likelihood function. For binned analysis, a counts cube produced by | ||
| 16 | -:doc:`ctbin` is required. For unbinned analysis, an event list processed by | ||
| 17 | -:doc:`ctselect` is required. Based on the input file format, ctlike | ||
| 18 | -automatically selects between binned and unbinned maximum likelihood analysis. | 12 | +Determines the flux, spectral index, position or extent of gamma-ray |
| 13 | +sources using maximum likelihood model fitting of CTA data. The analysis | ||
| 14 | +can be done in a binned or an unbinned formulation of the log-likelihood | ||
| 15 | +function. For binned analysis, a counts cube produced by :doc:`ctbin` is | ||
| 16 | +required. If several observations have been stacked into a single counts | ||
| 17 | +cube, an exposure cube, a PSF cube and a background cube have to be | ||
| 18 | +provided. For a single observation it is sufficient to specify the | ||
| 19 | +instrument response function. For unbinned analysis, an event list | ||
| 20 | +processed by :doc:`ctselect` is required. Based on files specified on | ||
| 21 | +input, ctlike automatically selects between binned or unbinned analysis. | ||
| 22 | +The tool can also be applied to lists of observations, specified in form | ||
| 23 | +of an observation definition file in XML format. Events of each observation | ||
| 24 | +are kept separate, and are associated to their appropriate instrument | ||
| 25 | +response function. | ||
| 19 | 26 | ||
| 20 | 27 | ||
| 21 | General parameters | 28 | General parameters |