Karim Sabri / ctools

Commit f9342fcb890ffac61b0420b23d5fd396f6c7afc8

Authored by Jürgen Knödlseder
1 parent f12b32d1

Update reference manual for csbkgmodel

Inline Side-by-side
Showing 2 changed files with 19 additions and 6 deletions
cscripts/csbkgmodel.par
  View file @f9342fc
@@ -26,9 +26,9 @@ outmodel, f, a, model.xml,,, "Output model definition XML file" @@ -26,9 +26,9 @@ outmodel, f, a, model.xml,,, "Output model definition XML file"
26 #================== 26 #==================
27 instrument, s, a, CTA,,, "Instrument name (for multi-instrument analysis)" 27 instrument, s, a, CTA,,, "Instrument name (for multi-instrument analysis)"
28 spatial, s, a, GAUSS,IRF|AEFF|GAUSS|GAUSS(E),, "Spatial model component" 28 spatial, s, a, GAUSS,IRF|AEFF|GAUSS|GAUSS(E),, "Spatial model component"
29 -snumbins, i, a, 3,1,200, "Number of energy nodes for sigma(E)"  
30 -smin, r, a, 0.1,,, "Lower energy limit for sigma(E) energy nodes (TeV)"  
31 -smax, r, a, 10.0,,, "Upper energy limit for sigma(E) energy nodes (TeV)" 29 +snumbins, i, a, 3,1,200, "Number of energy nodes for GAUSS(E) spatial model"
  30 +smin, r, a, 0.1,,, "Lower energy limit of energy nodes for GAUSS(E) spatial model (TeV)"
  31 +smax, r, a, 10.0,,, "Upper energy limit of energy nodes for GAUSS(E) spatial model (TeV)"
32 gradient, b, a, yes,,, "Allow for spatial gradient?" 32 gradient, b, a, yes,,, "Allow for spatial gradient?"
33 spectral, s, a, NODES,PLAW|NODES,, "Spectral model component" 33 spectral, s, a, NODES,PLAW|NODES,, "Spectral model component"
34 ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining spectral energy nodes" 34 ebinalg, s, a, LOG,FILE|LIN|LOG,, "Algorithm for defining spectral energy nodes"
doc/source/users/reference_manual/csbkgmodel.rst
  View file @f9342fc
@@ -50,9 +50,22 @@ General parameters @@ -50,9 +50,22 @@ General parameters
50 instrument, the instrument name will be extracted from the observation 50 instrument, the instrument name will be extracted from the observation
51 definition XML file. 51 definition XML file.
52 52
53 -``spatial <IRF|AEFF|GAUSS> [string]``  
54 - Spatial model component. So far IRF template, effective area and radial  
55 - Gaussian models are supported. 53 +``spatial <IRF|AEFF|GAUSS|GAUSS(E)> [string]``
  54 + Spatial model component. So far IRF template, effective area, a radial
  55 + Gaussian and an energy-dependent radial Gaussian models are supported.
  56 +
  57 +``snumbins [integer]``
  58 + Number of energy nodes for GAUSS(E) spatial model.
  59 + This parameter is only queried if ``GAUSS(E)`` is specified as spatial
  60 + model.
  61 +
  62 +``smin [real]``
  63 + Lower energy limit of energy nodes for GAUSS(E) spatial model (TeV).
  64 + This parameter is only queried if ``snumbins`` is larger than 1.
  65 +
  66 +``smax [real]``
  67 + Upper energy limit of energy nodes for GAUSS(E) spatial model (TeV).
  68 + This parameter is only queried if ``snumbins`` is larger than 1.
56 69
57 ``gradient [boolean]`` 70 ``gradient [boolean]``
58 Allow for a spatial gradient in the background event distribution? 71 Allow for a spatial gradient in the background event distribution?