Commit 6c570e24591ba308b3c317bde7554049663c37c2
1 parent
63480218
Update reference manual.
Showing
7 changed files
with
27 additions
and
19 deletions
doc/source/reference_manual/cscaldb.rst
| 1 | -.. _cscaldb: cscaldb ======= Dumps available instrument response functions. Synopsis -------- This scripts dumps all instrument response functions that are available in the calidation database into a log file. General parameters ------------------ None Standard parameters ------------------- ``(chatter = 2) [integer]`` Verbosity of the executable: chatter = 0: no information will be logged chatter = 1: only errors will be logged chatter = 2: errors and actions will be logged chatter = 3: report about the task execution chatter = 4: detailed report about the task execution ``(clobber = yes) [boolean]`` Specifies whether an existing output counts cube should be overwritten. ``(debug = no) [boolean]`` Enables debug mode. In debug mode the executable will dump any log file output to the console. ``(mode = ql) [string]`` Mode of automatic parameters (default is "ql", i.e. "query and learn"). Related tools ------------- None | |
| 2 | 1 | \ No newline at end of file |
| 2 | +.. _cscaldb: cscaldb ======= Dumps all available instrument response functions into log fil. Synopsis -------- This scripts dumps all instrument response functions that are available in the calibration database into the log file. If you want the information on the screen, add the ``debug=yes`` parameter. General parameters ------------------ None Standard parameters ------------------- ``(chatter = 2) [integer]`` Verbosity of the executable: chatter = 0: no information will be logged chatter = 1: only errors will be logged chatter = 2: errors and actions will be logged chatter = 3: report about the task execution chatter = 4: detailed report about the task execution ``(clobber = yes) [boolean]`` Specifies whether an existing output counts cube should be overwritten. ``(debug = no) [boolean]`` Enables debug mode. In debug mode the executable will dump any log file output to the console. ``(mode = ql) [string]`` Mode of automatic parameters (default is "ql", i.e. "query and learn"). Related tools ------------- None | |
| 3 | 3 | \ No newline at end of file | ... | ... |
doc/source/reference_manual/cslightcrv.rst
| ... | ... | @@ -9,7 +9,16 @@ Computes a lightcurve for a given source. |
| 9 | 9 | Synopsis |
| 10 | 10 | -------- |
| 11 | 11 | |
| 12 | -Computes a lightcurve for a given source. | |
| 12 | +Computes a lightcurve by performing a maximum likekihood fit in a series of | |
| 13 | +time bins. The time bins can be either specified in an ASCII file, as an | |
| 14 | +interval divided into equally sized time bins, or can be taken from the Good | |
| 15 | +Time Intervals of the observation(s). The format of the ASCII file is one | |
| 16 | +row per time bin, each specifying the start of stop value of the bin, separated | |
| 17 | +by a whitespace. The times are given in Modified Julian Days (MJD). | |
| 18 | +cslightcrv writes the fitted model parameters and their statistical errors | |
| 19 | +in a FITS file. In addition, it computes for each time bin the statistical | |
| 20 | +significance of the detection, expressed by the Test Statistics, and the | |
| 21 | +upper flux limit. | |
| 13 | 22 | |
| 14 | 23 | |
| 15 | 24 | General parameters | ... | ... |
doc/source/reference_manual/cspull.rst
| ... | ... | @@ -9,11 +9,11 @@ Generates pull distribution for all model parameters. |
| 9 | 9 | Synopsis |
| 10 | 10 | -------- |
| 11 | 11 | |
| 12 | -Generates pull distributions for all parameters in a model. | |
| 13 | -The pull is defined by the fitted value minus the simulated true value, | |
| 14 | -devided by the statistical uncertainty. | |
| 15 | -For unbiased parameter estimates, the pull distribution should follow a | |
| 16 | -Gaussian centred on 0 and a sigma parameter of 1. | |
| 12 | +Generates pull distributions for all parameters in a model. The pull is | |
| 13 | +defined by the fitted value minus the simulated true value, devided by | |
| 14 | +the statistical uncertainty. For unbiased parameter estimates, the pull | |
| 15 | +distribution should follow a Gaussian centred on 0 and a sigma parameter | |
| 16 | +of 1. | |
| 17 | 17 | |
| 18 | 18 | |
| 19 | 19 | General parameters | ... | ... |
doc/source/reference_manual/cssens.rst
| ... | ... | @@ -11,10 +11,10 @@ Synopsis |
| 11 | 11 | |
| 12 | 12 | Computes the CTA sensitivity for a number of energy bins using :doc:`ctlike`. |
| 13 | 13 | Crab spectra are fitted in narrow energy bins to simulated data, and the |
| 14 | -flux level is determined that leads to a particular significance. | |
| 15 | -The significance is estimated using the Test Statistic value. | |
| 16 | -The simplified assumption is made that the significance (in Gaussian | |
| 17 | -sigma) is the square root of the Test Statistic. | |
| 14 | +flux level is determined that leads to a particular significance. The | |
| 15 | +significance is estimated using the Test Statistic value. The simplified | |
| 16 | +assumption is made that the significance (in Gaussian sigma) is the square | |
| 17 | +root of the Test Statistic. | |
| 18 | 18 | |
| 19 | 19 | |
| 20 | 20 | General parameters | ... | ... |
doc/source/reference_manual/cstsdist.rst
| ... | ... | @@ -9,8 +9,8 @@ Generates the TS distribution for a particular model. |
| 9 | 9 | Synopsis |
| 10 | 10 | -------- |
| 11 | 11 | |
| 12 | -Generates the Test Statistics (TS) distribution for a particular model based on | |
| 13 | -Monte-Carlo simulations. | |
| 12 | +Generates the Test Statistics (TS) distribution for a particular model | |
| 13 | +based on Monte-Carlo simulations. | |
| 14 | 14 | |
| 15 | 15 | |
| 16 | 16 | General parameters | ... | ... |
doc/source/reference_manual/ctbin.rst
| ... | ... | @@ -10,9 +10,8 @@ Synopsis |
| 10 | 10 | -------- |
| 11 | 11 | |
| 12 | 12 | This tool computes the counts cube for use in a binned maximum likelihood |
| 13 | -analysis. | |
| 14 | -The counts cubes are 3-dimensional data cubes spanned by Right Ascension or | |
| 15 | -Galactic longitude, Declination or Galactic latitude, and energy. | |
| 13 | +analysis. The counts cubes are 3-dimensional data cubes spanned by Right | |
| 14 | +Ascension or Galactic longitude, Declination or Galactic latitude, and energy. | |
| 16 | 15 | The energy binning may be either linear, logarithmic, or custom defined. |
| 17 | 16 | If an observation definition XML file containing several observations is |
| 18 | 17 | provided on input, the tool will stack all data into a single counts cube. | ... | ... |
doc/source/reference_manual/ctmodel.rst
| ... | ... | @@ -9,9 +9,9 @@ Computes model counts cube. |
| 9 | 9 | Synopsis |
| 10 | 10 | -------- |
| 11 | 11 | |
| 12 | -This tool computes a model counts cube based on an XML model. | |
| 13 | -The counts cube is a 3-dimensional data cube spanned by Right Ascension or | |
| 14 | -Galactic longitude, Declination or Galactic latitude, and energy. | |
| 12 | +This tool computes a model counts cube based on an XML model. The counts | |
| 13 | +cube is a 3-dimensional data cube spanned by Right Ascension or Galactic | |
| 14 | +longitude, Declination or Galactic latitude, and energy. | |
| 15 | 15 | |
| 16 | 16 | |
| 17 | 17 | General parameters | ... | ... |