Karim Sabri / ctools

Commit cb85eb84e5a4f20d4a9cfa12e3c2b51696384618

Authored by Jürgen Knödlseder
1 parent 313aed90

Update model documentation

Inline Side-by-side
Showing 2 changed files with 127 additions and 31 deletions
doc/source/users/user_manual/models_spatial.rst
  View file @cb85eb8
... ... @@ -10,6 +10,11 @@ in ctools for gamma-ray sources.
10 10 Except of the ``DiffuseMapCube`` model, all spatial models are normalised
11 11 so that when integrated over the sphere the result is unity.
12 12  
  13 +.. note::
  14 + In the following model descriptions, celestial coordinates ``RA`` and ``DEC``
  15 + may be replaced by Galactic coordinates ``GLON`` and ``GLAT``.
  16 +
  17 +
13 18 Point source
14 19 ^^^^^^^^^^^^
15 20  
... ... @@ -32,34 +37,6 @@ Point source
32 37 * ``RA`` is the Right Ascension (degrees)
33 38 * ``DEC`` is the Declination (degrees)
34 39  
35   - Instead of ``RA`` and ``DEC`` one may use ``GLON`` and ``GLAT`` to give the
36   - position in Galactic coordinates
37   -
38   - .. code-block:: xml
39   -
40   - <source name="Crab" type="PointSource">
41   - <spatialModel type="PointSource">
42   - <parameter name="GLON" scale="1.0" value="184.5575" min="-360" max="360" free="1"/>
43   - <parameter name="GLAT" scale="1.0" value="-5.7844" min="-90" max="90" free="1"/>
44   - </spatialModel>
45   - <spectrum type="...">
46   - ...
47   - </spectrum>
48   - </source>
49   -
50   - where
51   -
52   - * ``GLON`` is the Galactic longitude (degrees)
53   - * ``GLAT`` is the Galactic latitude (degrees)
54   -
55   - .. note::
56   - Galactic coordinates using the ``GLON`` and ``GLAT`` parameters can be
57   - specified for all spatial models that require a sky coordinate. Galactic
58   - coordinates are transformed internally into celestial coordinates, and
59   - in case that a model is written into an XML file, the corresponding
60   - parameters will be replaced by the celestial coordinates ``RA`` and
61   - ``DEC``.
62   -
63 40 .. note::
64 41 For compatibility with the Fermi/LAT ScienceTools the model type
65 42 ``PointSource`` can be replaced by ``SkyDirFunction``.
... ... @@ -190,7 +167,7 @@ RadialGeneralGaussian
190 167 * :math:`\eta` = ``R_Index``
191 168  
192 169 The model normalisation is correct in the small angle approximation and for
193   - :math:`\eta` order unity or smaller.
  170 + :math:`\eta` of the order of unity or smaller.
194 171  
195 172 RadialShell
196 173 ~~~~~~~~~~~
... ... @@ -237,6 +214,98 @@ RadialShell
237 214 * :math:`\theta_{\rm in}` = ``Radius`` (degrees)
238 215  
239 216  
  217 +Radial profiles
  218 +~~~~~~~~~~~~~~~
  219 +
  220 + Radial profiles are defined by a arbitrary function of the radial distance from a central
  221 + position. The following radial profiles exist:
  222 +
  223 +Burkert Dark matter profile
  224 +...........................
  225 +
  226 + .. code-block:: xml
  227 +
  228 + <source name="Crab" type="ExtendedSource">
  229 + <spatialModel type="DMBurkertProfile">
  230 + <parameter name="RA" scale="1.0" value="83.6331" min="-360" max="360" free="1"/>
  231 + <parameter name="DEC" scale="1.0" value="22.0145" min="-90" max="90" free="1"/>
  232 + <parameter name="ScaleRadius" scale="1.0" value="21.5" min="0.0001" max="1000" free="0"/>
  233 + <parameter name="ScaleDensity" scale="1.0" value="0.2" min="0.0001" max="1000" free="0"/>
  234 + <parameter name="HaloDistance" scale="1.0" value="7.94" min="0.0001" max="1000" free="0"/>
  235 + <parameter name="ThetaMin" scale="1.0" value="1.0e-6" min="1.0e-10" max="1000" free="0"/>
  236 + <parameter name="ThetaMax" scale="1.0" value="180.0" min="0.0001" max="1000" free="0"/>
  237 + <parameter name="CoreRadius" scale="1.0" value="0.5" min="0.0001" max="1000" free="0"/>
  238 + </spatialModel>
  239 + <spectrum type="...">
  240 + ...
  241 + </spectrum>
  242 + </source>
  243 +
  244 +Einasto Dark matter profile
  245 +...........................
  246 +
  247 + .. code-block:: xml
  248 +
  249 + <source name="Crab" type="ExtendedSource">
  250 + <spatialModel type="DMEinastoProfile">
  251 + <parameter name="RA" scale="1.0" value="83.6331" min="-360" max="360" free="1"/>
  252 + <parameter name="DEC" scale="1.0" value="22.0145" min="-90" max="90" free="1"/>
  253 + <parameter name="ScaleRadius" scale="1.0" value="21.5" min="0.0001" max="1000" free="0"/>
  254 + <parameter name="ScaleDensity" scale="1.0" value="0.2" min="0.0001" max="1000" free="0"/>
  255 + <parameter name="HaloDistance" scale="1.0" value="7.94" min="0.0001" max="1000" free="0"/>
  256 + <parameter name="Alpha" scale="1.0" value="0.17" min="0.0001" max="1000" free="0"/>
  257 + <parameter name="ThetaMin" scale="1.0" value="1.0e-6" min="1.0e-10" max="1000" free="0"/>
  258 + <parameter name="ThetaMax" scale="1.0" value="180.0" min="0.0001" max="1000" free="0"/>
  259 + <parameter name="CoreRadius" scale="1.0" value="0.5" min="0.0001" max="1000" free="0"/>
  260 + </spatialModel>
  261 + <spectrum type="...">
  262 + ...
  263 + </spectrum>
  264 + </source>
  265 +
  266 +Zhao Dark matter profile
  267 +........................
  268 +
  269 + .. code-block:: xml
  270 +
  271 + <source name="Crab" type="ExtendedSource">
  272 + <spatialModel type="DMZhaoProfile">
  273 + <parameter name="RA" scale="1.0" value="83.6331" min="-360" max="360" free="1"/>
  274 + <parameter name="DEC" scale="1.0" value="22.0145" min="-90" max="90" free="1"/>
  275 + <parameter name="ScaleRadius" scale="1.0" value="21.5" min="0.0001" max="1000" free="0"/>
  276 + <parameter name="ScaleDensity" scale="1.0" value="0.2" min="0.0001" max="1000" free="0"/>
  277 + <parameter name="HaloDistance" scale="1.0" value="7.94" min="0.0001" max="1000" free="0"/>
  278 + <parameter name="Alpha" scale="1.0" value="0.17" min="0.0001" max="1000" free="0"/>
  279 + <parameter name="Beta" scale="1.0" value="3.00" min="0.0001" max="1000" free="0"/>
  280 + <parameter name="Gamma" scale="1.0" value="1.00" min="0.0001" max="1000" free="0"/>
  281 + <parameter name="ThetaMin" scale="1.0" value="1.0e-6" min="1.0e-10" max="1000" free="0"/>
  282 + <parameter name="ThetaMax" scale="1.0" value="180.0" min="0.0001" max="1000" free="0"/>
  283 + <parameter name="CoreRadius" scale="1.0" value="0.5" min="0.0001" max="1000" free="0"/>
  284 + </spatialModel>
  285 + <spectrum type="...">
  286 + ...
  287 + </spectrum>
  288 + </source>
  289 +
  290 +Gaussian profile
  291 +................
  292 +
  293 + This profile is equivalent to ``RadialGaussian``.
  294 +
  295 + .. code-block:: xml
  296 +
  297 + <source name="Crab" type="ExtendedSource">
  298 + <spatialModel type="GaussianProfile">
  299 + <parameter name="RA" scale="1.0" value="83.6331" min="-360" max="360" free="1"/>
  300 + <parameter name="DEC" scale="1.0" value="22.0145" min="-90" max="90" free="1"/>
  301 + <parameter name="Sigma" scale="1.0" value="0.45" min="0.01" max="10" free="1"/>
  302 + </spatialModel>
  303 + <spectrum type="...">
  304 + ...
  305 + </spectrum>
  306 + </source>
  307 +
  308 +
240 309 Elliptical source
241 310 ^^^^^^^^^^^^^^^^^
242 311  
... ... @@ -325,7 +394,7 @@ EllipticalGeneralGaussian
325 394 <parameter name="PA" scale="1.0" value="45.0" min="-360" max="360" free="1"/>
326 395 <parameter name="MinorRadius" scale="1.0" value="0.5" min="0.001" max="10" free="1"/>
327 396 <parameter name="MajorRadius" scale="1.0" value="2.0" min="0.001" max="10" free="1"/>
328   - <parameter name="R_Index" scale="1.0" value="0.5" min="0.01" max="10" free="1"/>
  397 + <parameter name="R_Index" scale="1.0" value="0.5" min="0.01" max="10" free="1"/>
329 398 </spatialModel>
330 399 <spectrum type="...">
331 400 ...
... ... @@ -357,7 +426,7 @@ EllipticalGeneralGaussian
357 426 * :math:`\eta` = ``R_Index``
358 427  
359 428 The model normalisation is correct in the small angle approximation and for
360   - :math:`\eta` order unity or smaller.
  429 + :math:`\eta` of the order of unity or smaller.
361 430  
362 431  
363 432 Diffuse source
... ...
doc/source/users/user_manual/models_spectral.rst
  View file @cb85eb8
... ... @@ -444,6 +444,33 @@ Node function
444 444 ordering.
445 445  
446 446  
  447 +Bin function
  448 +^^^^^^^^^^^^
  449 +
  450 + .. code-block:: xml
  451 +
  452 + <spectrum type="BinFunction">
  453 + <parameter name="Index" scale="-1" value="2.48" min="0.0" max="+5.0" free="0"/>
  454 + <bin>
  455 + <parameter scale="1.0" name="LowerLimit" min="0.1" max="1.0e20" value="0.75" free="0"/>
  456 + <parameter scale="1.0" name="UpperLimit" min="0.1" max="1.0e20" value="1.0" free="0"/>
  457 + <parameter scale="1e-07" name="Intensity" min="1e-07" max="1000.0" value="1.0" free="1"/>
  458 + </bin>
  459 + <bin>
  460 + <parameter scale="1.0" name="LowerLimit" min="0.1" max="1.0e20" value="1.0" free="0"/>
  461 + <parameter scale="1.0" name="UpperLimit" min="0.1" max="1.0e20" value="3.0" free="0"/>
  462 + <parameter scale="1e-07" name="Intensity" min="1e-07" max="1000.0" value="0.5" free="1"/>
  463 + </bin>
  464 + </spectrum>
  465 +
  466 + This spectral model component implements energy bins defined by ``LowerLimit`` and
  467 + ``UpperLimit`` values given in units of :math:`{\rm MeV}`. Within an energy bin the
  468 + intensity follows a power law with spectral index defined by the ``Index`` parameter.
  469 + Intensities are given in units of
  470 + :math:`{\rm ph}\,\,{\rm cm}^{-2}\,{\rm s}^{-1}\,{\rm MeV}^{-1}`
  471 + and are specified for the logarithmic bin centre.
  472 +
  473 +
447 474 Table model
448 475 ^^^^^^^^^^^
449 476  
... ...