Domenico Tiziani / ctools

Commit 16b9aa8836b2e262c02dc068717a4e673c76ea1c

Authored by Jürgen Knödlseder
1 parent ef17b7fb

Update csbkgmodel reference documentation

Inline Side-by-side
Showing 1 changed file with 19 additions and 3 deletions
doc/source/users/reference_manual/csbkgmodel.rst
  View file @16b9aa8
... ... @@ -9,9 +9,24 @@ Generates background model for 3D analysis.
9 9 Synopsis
10 10 --------
11 11  
12   -This script generates a background model for a 3D analysis.
13   -
14   -:ref:`csbkgmodel` writes an model definition XML file.
  12 +This script generates a background model for a 3D analysis. The background
  13 +model is composed of spatial and spectral components, controlled through the
  14 +parameters ``spatial`` and ``spectral``. The spatial component can be either
  15 +an effective area model (``AEFF``), a template extracted from the instrument
  16 +response function (``IRF``) or an analytical 2D Gaussian function (``GAUSS``).
  17 +For the analytical 2D Gaussian function, a bilinear multiplicative background
  18 +gradient can be added using ``gradient=yes``. The spectral component can be
  19 +either a power law (``PLAW``) or a nodes function (``NODES``). The number of
  20 +nodes for the node function is controlled through the ``enumbins`` parameter.
  21 +Specific node energies can be specified through the ``ebinalg`` parameter.
  22 +
  23 +If ``runwise=yes``, a background model component will be added for each observation
  24 +in the input observation definition XML file. The script fits the background
  25 +model to the input observation(s) to preset the background model parameters
  26 +with resonable values.
  27 +
  28 +On output, :ref:`csbkgmodel` writes an model definition XML file that can be
  29 +used for model fitting. Source model components have to be added as needed.
15 30  
16 31  
17 32 General parameters
... ... @@ -107,3 +122,4 @@ Related tools or scripts
107 122 ------------------------
108 123  
109 124 :doc:`ctlike`
  125 +:doc:`csmodelmerge`
... ...