From 6c570e24591ba308b3c317bde7554049663c37c2 Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Sun, 1 Nov 2015 22:16:36 +0100 Subject: [PATCH] Update reference manual. --- doc/source/reference_manual/cscaldb.rst | 2 +- doc/source/reference_manual/cslightcrv.rst | 11 ++++++++++- doc/source/reference_manual/cspull.rst | 10 +++++----- doc/source/reference_manual/cssens.rst | 8 ++++---- doc/source/reference_manual/cstsdist.rst | 4 ++-- doc/source/reference_manual/ctbin.rst | 5 ++--- doc/source/reference_manual/ctmodel.rst | 6 +++--- 7 files changed, 27 insertions(+), 19 deletions(-) diff --git a/doc/source/reference_manual/cscaldb.rst b/doc/source/reference_manual/cscaldb.rst index 31bede1..536d98c 100644 --- a/doc/source/reference_manual/cscaldb.rst +++ b/doc/source/reference_manual/cscaldb.rst @@ -1 +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 \ No newline at end of file +.. _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 \ No newline at end of file diff --git a/doc/source/reference_manual/cslightcrv.rst b/doc/source/reference_manual/cslightcrv.rst index c96932e..ce71b6f 100644 --- a/doc/source/reference_manual/cslightcrv.rst +++ b/doc/source/reference_manual/cslightcrv.rst @@ -9,7 +9,16 @@ Computes a lightcurve for a given source. Synopsis -------- -Computes a lightcurve for a given source. +Computes a lightcurve by performing a maximum likekihood fit in a series of +time bins. The time bins can be either specified in an ASCII file, as an +interval divided into equally sized time bins, or can be taken from the Good +Time Intervals of the observation(s). The format of the ASCII file is one +row per time bin, each specifying the start of stop value of the bin, separated +by a whitespace. The times are given in Modified Julian Days (MJD). +cslightcrv writes the fitted model parameters and their statistical errors +in a FITS file. In addition, it computes for each time bin the statistical +significance of the detection, expressed by the Test Statistics, and the +upper flux limit. General parameters diff --git a/doc/source/reference_manual/cspull.rst b/doc/source/reference_manual/cspull.rst index 2c3ac4f..a058a2c 100644 --- a/doc/source/reference_manual/cspull.rst +++ b/doc/source/reference_manual/cspull.rst @@ -9,11 +9,11 @@ Generates pull distribution for all model parameters. Synopsis -------- -Generates pull distributions for all parameters in a model. -The pull is defined by the fitted value minus the simulated true value, -devided by the statistical uncertainty. -For unbiased parameter estimates, the pull distribution should follow a -Gaussian centred on 0 and a sigma parameter of 1. +Generates pull distributions for all parameters in a model. The pull is +defined by the fitted value minus the simulated true value, devided by +the statistical uncertainty. For unbiased parameter estimates, the pull +distribution should follow a Gaussian centred on 0 and a sigma parameter +of 1. General parameters diff --git a/doc/source/reference_manual/cssens.rst b/doc/source/reference_manual/cssens.rst index 36f4033..64a628a 100644 --- a/doc/source/reference_manual/cssens.rst +++ b/doc/source/reference_manual/cssens.rst @@ -11,10 +11,10 @@ Synopsis Computes the CTA sensitivity for a number of energy bins using :doc:`ctlike`. Crab spectra are fitted in narrow energy bins to simulated data, and the -flux level is determined that leads to a particular significance. -The significance is estimated using the Test Statistic value. -The simplified assumption is made that the significance (in Gaussian -sigma) is the square root of the Test Statistic. +flux level is determined that leads to a particular significance. The +significance is estimated using the Test Statistic value. The simplified +assumption is made that the significance (in Gaussian sigma) is the square +root of the Test Statistic. General parameters diff --git a/doc/source/reference_manual/cstsdist.rst b/doc/source/reference_manual/cstsdist.rst index 43fd28a..d6e9495 100644 --- a/doc/source/reference_manual/cstsdist.rst +++ b/doc/source/reference_manual/cstsdist.rst @@ -9,8 +9,8 @@ Generates the TS distribution for a particular model. Synopsis -------- -Generates the Test Statistics (TS) distribution for a particular model based on -Monte-Carlo simulations. +Generates the Test Statistics (TS) distribution for a particular model +based on Monte-Carlo simulations. General parameters diff --git a/doc/source/reference_manual/ctbin.rst b/doc/source/reference_manual/ctbin.rst index 1e8f377..45ed5b5 100644 --- a/doc/source/reference_manual/ctbin.rst +++ b/doc/source/reference_manual/ctbin.rst @@ -10,9 +10,8 @@ Synopsis -------- This tool computes the counts cube for use in a binned maximum likelihood -analysis. -The counts cubes are 3-dimensional data cubes spanned by Right Ascension or -Galactic longitude, Declination or Galactic latitude, and energy. +analysis. The counts cubes are 3-dimensional data cubes spanned by Right +Ascension or Galactic longitude, Declination or Galactic latitude, and energy. The energy binning may be either linear, logarithmic, or custom defined. If an observation definition XML file containing several observations is provided on input, the tool will stack all data into a single counts cube. diff --git a/doc/source/reference_manual/ctmodel.rst b/doc/source/reference_manual/ctmodel.rst index b5eb7ef..199f2bd 100644 --- a/doc/source/reference_manual/ctmodel.rst +++ b/doc/source/reference_manual/ctmodel.rst @@ -9,9 +9,9 @@ Computes model counts cube. Synopsis -------- -This tool computes a model counts cube based on an XML model. -The counts cube is a 3-dimensional data cube spanned by Right Ascension or -Galactic longitude, Declination or Galactic latitude, and energy. +This tool computes a model counts cube based on an XML model. The counts +cube is a 3-dimensional data cube spanned by Right Ascension or Galactic +longitude, Declination or Galactic latitude, and energy. General parameters -- libgit2 0.21.4