Luigi Tibaldo / ctools

Commit b58507bd5ecca8908a287568e79b0f2ac0bd948e

Authored by Jürgen Knödlseder
1 parent 834a7cec

Update the cssens reference manual (#3555)

Inline Side-by-side
Showing 1 changed file with 22 additions and 8 deletions
doc/source/users/reference_manual/cssens.rst
  View file @b58507b
... ... @@ -13,15 +13,29 @@ This script computes the differential or integrated CTA sensitivity using
13 13 maximum likelihood fitting of a test source. The differential sensitivity is
14 14 determined for a number of energy bins, the integral sensitivity is determined
15 15 for a number of energy thresholds. The test source is fitted to simulated data
16   -using :doc:`ctlike` to determine it's detection significance as a function of
  16 +using :doc:`ctlike` to determine its detection significance as a function of
17 17 source flux. The source flux is then varied until the source significance
18 18 achieves a given level, specified by the (hidden) significance parameter
19   -``sigma``.
20   -
21   -The significance is estimated using the Test Statistic value, defined as twice
22   -the log-likelihood difference that is obtained when fitting the simulated data
23   -with and without the test source. The simplified assumption is made that the
24   -significance (in Gaussian sigma) is the square root of the Test Statistic.
  19 +``sigma``. As test source, any source in the input model definition XML file
  20 +specified by ``inmodel`` can be used; the test source name is specified by the
  21 +``srcname`` parameter.
  22 +
  23 +The detection significance is estimated using the Test Statistic value, defined
  24 +as twice the log-likelihood difference that is obtained when fitting the
  25 +simulated data with and without the test source. The simplified assumption is
  26 +made that the significance (in Gaussian sigma) is the square root of the Test
  27 +Statistic.
  28 +
  29 +By default the script simulates a single pointing with an exposure time
  30 +specified by the ``duration`` parameter. The pointing direction will be set to
  31 +the position of the test source, offset by the value specified by the ``offset``
  32 +parameter. If the test source has no position (which is for example the case
  33 +for a test source comprised of a map or map cube), a pointing direction of
  34 +(0,0) will be assumed in Right Ascension and Declination.
  35 +
  36 +Alternatively, an observation definition XML file can be specified using the
  37 +hidden ``inobs`` parameter. In that way the user has full control over the
  38 +pointing sequence that should be simulated for the sensitivity estimation.
25 39  
26 40 :ref:`cssens` supports multiprocessing. By default the analysis for each energy
27 41 bin/threshold will be performed in parallel over as many processes as the number of
... ... @@ -48,7 +62,7 @@ General parameters
48 62 Input event list, counts cube or observation definition XML file.
49 63  
50 64 ``inmodel [file]``
51   - Input model XML file.
  65 + Input model definition XML file.
52 66  
53 67 ``srcname [string]``
54 68 Name of the source in the source model XML file which should be used
... ...