Commit c6aa9b8ea448253ae04332eaf30521563862bbdd
1 parent
b73a6e3a
Correct documentation on units of spectral models (#1557)
Showing
1 changed file
with
6 additions
and
14 deletions
doc/source/users/user_manual/getting_started/models.rst
| @@ -374,26 +374,18 @@ in ctools. | @@ -374,26 +374,18 @@ in ctools. | ||
| 374 | Source intensities are generally given in units of | 374 | Source intensities are generally given in units of |
| 375 | :math:`{\rm ph}\,\,{\rm cm}^{-2}\,{\rm s}^{-1}\,{\rm MeV}^{-1}`. | 375 | :math:`{\rm ph}\,\,{\rm cm}^{-2}\,{\rm s}^{-1}\,{\rm MeV}^{-1}`. |
| 376 | 376 | ||
| 377 | - Exceptions to this rule exist for the following spatial models: | ||
| 378 | - | ||
| 379 | - - ``DiffuseIsotropic``: intensity units are given per steradian, e.g. | ||
| 380 | - :math:`{\rm ph}\,\,{\rm cm}^{-2}\,{\rm s}^{-1}\,{\rm MeV}^{-1}\,{\rm sr}^{-1}` | ||
| 381 | - | ||
| 382 | - - ``DiffuseMapCube``: intensities are unitless, the spectral model | ||
| 383 | - presents a relative scaling of the diffuse model | 377 | + An exception to this rule exists for the ``DiffuseMapCube`` spatial |
| 378 | + model where intensities are unitless and the spectral model presents a | ||
| 379 | + relative scaling of the diffuse model cube values. | ||
| 384 | 380 | ||
| 385 | If spectral models are used for a background model component, intensity | 381 | If spectral models are used for a background model component, intensity |
| 386 | units are generally given in | 382 | units are generally given in |
| 387 | :math:`{\rm counts}\,\,{\rm cm}^{-2}\,{\rm s}^{-1}\,{\rm MeV}^{-1}\,{\rm sr}^{-1}` | 383 | :math:`{\rm counts}\,\,{\rm cm}^{-2}\,{\rm s}^{-1}\,{\rm MeV}^{-1}\,{\rm sr}^{-1}` |
| 388 | and correspond to the on-axis count rate. | 384 | and correspond to the on-axis count rate. |
| 389 | 385 | ||
| 390 | - Exceptions to this rule exist for the following spatial models: | ||
| 391 | - | ||
| 392 | - - ``CTAIrfBackground``: intensities are unitless, the spectral model | ||
| 393 | - presents a relative scaling of the background model | ||
| 394 | - | ||
| 395 | - - ``CTACubeBackground``: intensities are unitless, the spectral model | ||
| 396 | - presents a relative scaling of the background model | 386 | + Exceptions to this rule exist for the ``CTAIrfBackground`` and |
| 387 | + ``CTACubeBackground`` models where intensities are unitless and the spectral | ||
| 388 | + model presents a relative scaling of the background model values. | ||
| 397 | 389 | ||
| 398 | 390 | ||
| 399 | Constant | 391 | Constant |