Commit b7c7721eaff8c89eacccd7a45ef508f763da9eb6

Authored by Jürgen Knödlseder
1 parent 7da5e0b4

Add documentation on normalisation of diffuse map and diffuse map cube models (#2997)

doc/source/users/user_manual/models_implementation.rst
... ... @@ -15,6 +15,42 @@ a temporal component (tag ``<temporal>``).
15 15 .. math::
16 16 M(p,E,t) = M_{\rm spatial}(p|E) \times M_{\rm spectral}(E) \times M_{\rm temporal}(t)
17 17  
  18 +where :math:`M(p,E,t)` is given in units of
  19 +:math:`photons \,\, cm^{-2} s^{-1} MeV^{-1} sr^{-1}`.
  20 +
  21 +The spatial model component describes the energy dependent morphology of the
  22 +source.
  23 +It satisfies
  24 +
  25 +.. math::
  26 + \int_{\Omega} M_{\rm spatial}(p|E) \, d\Omega = 1
  27 +
  28 +for all :math:`E`, hence the spatial component does not
  29 +impact the spatially integrated spectral and temporal properties of the
  30 +source (the integration is done here over the spatial parameters
  31 +:math:`p` in a spherical coordinate system).
  32 +The units of the spatial model component are
  33 +:math:`[M_{\rm spatial}] = {\rm sr}^{-1}`
  34 +(but see the exception of the
  35 +:ref:`DiffuseMapCube spatial model component <um_models_spatial_src_diffuse_cube>`).
  36 +
  37 +The spectral model component describes the spatially integrated spectral
  38 +distribution of the source.
  39 +It satisfies
  40 +
  41 +.. math::
  42 + \int_{E} M_{\rm spectral}(E) \, dE = \Phi
  43 +
  44 +where :math:`\Phi` is the spatially and spectrally integrated total source
  45 +flux.
  46 +The units of the spectral model component
  47 +are :math:`[M_{\rm spectral}] = {\rm cm}^{-2} {\rm s}^{-1} {\rm MeV}^{-1}`.
  48 +
  49 +The temporal model component describes the relative variation of the
  50 +source flux with respect to the mean value given by the spectral model
  51 +component.
  52 +The temporal model component is unit less.
  53 +
18 54 In this specific example, the source component ``Crab`` describes
19 55 a point source at the location of the Crab nebula with a power law spectral
20 56 shape that is constant in time.
... ...
doc/source/users/user_manual/models_spatial_src.rst
... ... @@ -61,6 +61,9 @@ Point source
61 61 Radial source
62 62 ^^^^^^^^^^^^^
63 63  
  64 +RadialDisk
  65 +~~~~~~~~~~
  66 +
64 67 The ``RadialDisk`` model describes a uniform intensity distribution within
65 68 a given radius
66 69  
... ... @@ -83,6 +86,9 @@ Radial source
83 86 * ``DEC`` is the Declination (degrees)
84 87 * ``Radius`` is the disk radius (degrees)
85 88  
  89 +RadialGaussian
  90 +~~~~~~~~~~~~~~
  91 +
86 92 The ``RadialGaussian`` model describes a Gaussian intensity distribution
87 93  
88 94 .. code-block:: xml
... ... @@ -108,7 +114,10 @@ Radial source
108 114  
109 115 * ``RA`` is the Right Ascension (degrees)
110 116 * ``DEC`` is the Declination (degrees)
111   - * :math:`\sigma` == ``Sigma`` (degrees)
  117 + * :math:`\sigma` = ``Sigma`` (degrees)
  118 +
  119 +RadialShell
  120 +~~~~~~~~~~~
112 121  
113 122 The ``RadialShell`` model describes a spherical shell projected on the sky
114 123  
... ... @@ -159,6 +168,9 @@ Radial source
159 168 Elliptical source
160 169 ^^^^^^^^^^^^^^^^^
161 170  
  171 +EllipticalDisk
  172 +~~~~~~~~~~~~~~
  173 +
162 174 The ``EllipticalDisk`` model describes a uniform intensity distribution within
163 175 an elliptical circumference:
164 176  
... ... @@ -185,6 +197,9 @@ Elliptical source
185 197 * ``MinorRadius`` is the minor radius of the ellipse (degrees)
186 198 * ``MajorRadius`` is the major radius of the ellipse (degrees)
187 199  
  200 +EllipticalGaussian
  201 +~~~~~~~~~~~~~~~~~~
  202 +
188 203 The ``EllipticalGaussian`` model describes a Gaussian intensity distribution
189 204  
190 205 .. code-block:: xml
... ... @@ -232,6 +247,9 @@ Elliptical source
232 247 Diffuse source
233 248 ^^^^^^^^^^^^^^
234 249  
  250 +DiffuseIsotropic
  251 +~~~~~~~~~~~~~~~~
  252 +
235 253 The ``DiffuseIsotropic`` model describes an isotropic intensity distribution
236 254  
237 255 .. code-block:: xml
... ... @@ -253,6 +271,9 @@ Diffuse source
253 271 For compatibility with the Fermi/LAT ScienceTools the model type
254 272 ``DiffuseIsotropic`` can be replaced by ``ConstantValue``.
255 273  
  274 +DiffuseMap
  275 +~~~~~~~~~~
  276 +
256 277 The ``DiffuseMap`` model describes an arbitrary intensity distribution in
257 278 form of a sky map
258 279  
... ... @@ -281,8 +302,15 @@ Diffuse source
281 302 ``Normalization`` can be replaced by ``Prefactor``.
282 303  
283 304 .. note::
284   - You may add the ``normalize="0"`` to the spatial model tag to avoid the
285   - normalization of the diffuse map to an integral of unity
  305 + By default, the diffuse map is normalised so that
  306 +
  307 + .. math::
  308 + \int_{\Omega} M_{\rm spatial}(p|E) \, d\Omega = 1
  309 +
  310 + which means that the units of the spatial model component are
  311 + :math:`[M_{\rm spatial}] = {\rm sr}^{-1}`.
  312 + To avoid the normalisation you may add the ``normalize="0"`` attribute
  313 + to the spatial model tag.
286 314  
287 315 .. code-block:: xml
288 316  
... ... @@ -295,6 +323,19 @@ Diffuse source
295 323 </spectrum>
296 324 </source>
297 325  
  326 + In that case, generally
  327 +
  328 + .. math::
  329 + \int_{\Omega} M_{\rm spatial}(p|E) \, d\Omega \neq 1
  330 +
  331 + and the spectral component cannot be directly interpreted as a physical
  332 + source intensity.
  333 +
  334 + .. _um_models_spatial_src_diffuse_cube:
  335 +
  336 +DiffuseMapCube
  337 +~~~~~~~~~~~~~~
  338 +
298 339 The ``DiffuseMapCube`` model describes an arbitrary energy-dependent intensity
299 340 distribution in form of a map cube
300 341  
... ... @@ -313,6 +354,18 @@ Diffuse source
313 354  
314 355 * ``Normalization`` is a normalization value
315 356  
  357 + Note that the map cube is not normalised to unit, hence generally
  358 +
  359 + .. math::
  360 + \int_{\Omega} M_{\rm spatial}(p|E) \, d\Omega \neq 1
  361 +
  362 + To compute the flux in a given energy band for a ``DiffuseMapCube`` model
  363 + you have to integrated both the spatial and spectral components, i.e.
  364 +
  365 + .. math::
  366 + \Phi = \int_{\Omega} \int_{E} M_{\rm spatial}(p|E) \times
  367 + M_{\rm spectral}(E)\, d\Omega \, dE
  368 +
316 369 .. note::
317 370 For compatibility with the Fermi/LAT ScienceTools the model type
318 371 ``DiffuseMapCube`` can be replaced by ``MapCubeFunction`` and the parameter
... ...