Commit ebf87bb91dce2562bdfefe6180833144ca848945

Authored by Luigi Tibaldo
1 parent 858834ee

doc for generalized Gaussian

doc/source/users/user_manual/models_spatial.rst
... ... @@ -156,6 +156,42 @@ RadialGaussian
156 156 * ``DEC`` is the Declination of the Gaussian centre (degrees)
157 157 * :math:`\sigma` = ``Sigma`` (degrees)
158 158  
  159 + RadialGeneralGaussian
  160 +~~~~~~~~~~~~~~
  161 +
  162 + The ``RadialGeneralGaussian`` model describes a generalised Gaussian
  163 + intensity distribution, with the radial profile index as a model parameter.
  164 +
  165 + .. code-block:: xml
  166 +
  167 + <source name="Crab" type="ExtendedSource">
  168 + <spatialModel type="RadialGaussian">
  169 + <parameter name="RA" scale="1.0" value="83.6331" min="-360" max="360" free="1"/>
  170 + <parameter name="DEC" scale="1.0" value="22.0145" min="-90" max="90" free="1"/>
  171 + <parameter name="Radius" scale="1.0" value="0.20" min="0.01" max="10" free="1"/>
  172 + <parameter name="R_Index" scale="1.0" value="0.5" min="0.01" max="10" free="1"/>
  173 + </spatialModel>
  174 + <spectrum type="...">
  175 + ...
  176 + </spectrum>
  177 + </source>
  178 +
  179 + and implements
  180 +
  181 + .. math::
  182 + M_{\rm spatial}(\theta) = \frac{1}{2 \pi r^2 \eta \Gamma(2\eta)} \exp
  183 + \left[- \left(\frac{\theta^2}{r^2}\right)^\frac{1}{\eta} \right],
  184 +
  185 + where
  186 +
  187 + * ``RA`` is the Right Ascension of the Gaussian centre (degrees)
  188 + * ``DEC`` is the Declination of the Gaussian centre (degrees)
  189 + * :math:`r` = ``Radius`` (degrees)
  190 + * :math:`\eta` = ``R_Index``
  191 +
  192 +The model normalisation is correct in the small angle
  193 + approximation and for :math:`\eta` order unity or smaller.
  194 +
159 195 RadialShell
160 196 ~~~~~~~~~~~
161 197  
... ... @@ -275,6 +311,54 @@ EllipticalGaussian
275 311 from North
276 312 * :math:`\phi` is the azimuth angle with respect to North.
277 313  
  314 + EllipticalGeneralGaussian
  315 +~~~~~~~~~~~~~~~~~~
  316 +
  317 + The ``EllipticalGeneralGaussian`` model describes a Gaussian intensity distribution
  318 +
  319 + .. code-block:: xml
  320 +
  321 + <source name="Crab" type="ExtendedSource">
  322 + <spatialModel type="EllipticalGeneralGaussian">
  323 + <parameter name="RA" scale="1.0" value="83.6331" min="-360" max="360" free="1"/>
  324 + <parameter name="DEC" scale="1.0" value="22.0145" min="-90" max="90" free="1"/>
  325 + <parameter name="PA" scale="1.0" value="45.0" min="-360" max="360" free="1"/>
  326 + <parameter name="MinorRadius" scale="1.0" value="0.5" min="0.001" max="10" free="1"/>
  327 + <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"/>
  329 + </spatialModel>
  330 + <spectrum type="...">
  331 + ...
  332 + </spectrum>
  333 + </source>
  334 +
  335 + and implements
  336 +
  337 + .. math::
  338 + M_{\rm spatial}(\theta, \phi) = \frac{1}{2 \pi r^2 \eta
  339 + \Gamma(2\eta)} \exp \left[ -\left(\frac{\theta^2}{2 r_\mathrm{eff}^2}\right)^\frac{1}{\eta} \right],
  340 +
  341 + with
  342 +
  343 + .. math::
  344 + r_\mathrm{eff} = \frac{ab} {\sqrt{\left( a \sin (\phi - \phi_0) \right)^2 +
  345 + \sqrt{\left( b \cos (\phi - \phi_0) \right)^2}}}
  346 +
  347 + where
  348 +
  349 + * ``RA`` is the Right Ascension (degrees)
  350 + * ``DEC`` is the Declination (degrees)
  351 + * ``PA`` is the position angle, counted counterclockwise from North (degrees)
  352 + * :math:`a` = ``MinorRadius`` (degrees)
  353 + * :math:`b` = ``MajorRadius`` (degrees)
  354 + * :math:`\phi_0` is the position angle of the ellipse, counted counterclockwise
  355 + from North
  356 + * :math:`\phi` is the azimuth angle with respect to North
  357 + * :math:`\eta` = ``R_Index``
  358 +
  359 + The model normalisation is correct in the small angle
  360 + approximation and for :math:`\eta` order unity or smaller.
  361 +
278 362  
279 363 Diffuse source
280 364 ^^^^^^^^^^^^^^
... ...