From b653863bbcfda99dabbfd0f5307cc5024530f6b3 Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Fri, 30 Oct 2015 09:45:42 +0100 Subject: [PATCH] Add information to the Doxygen documentation. --- src/model/GModelSpatialEllipticalGauss.cpp | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/model/GModelSpatialEllipticalGauss.cpp b/src/model/GModelSpatialEllipticalGauss.cpp index cab1059..dfddf9c 100644 --- a/src/model/GModelSpatialEllipticalGauss.cpp +++ b/src/model/GModelSpatialEllipticalGauss.cpp @@ -276,10 +276,13 @@ GModelSpatialEllipticalGauss* GModelSpatialEllipticalGauss::clone(void) const * * The normalisation constant \f${\tt m\_norm}\f$ which is the inverse of the * solid angle subtended by an ellipse is given by + * \f[ + * {\tt m\_norm} = \frac{1}{2 \pi \times a \times b} + * \f] * - * @todo Quote formula for ellipse solid angle - * - * (see the update() method). + * @warning + * The normalization of the elliptical Gaussian is only valid in the small + * angle approximation. ***************************************************************************/ double GModelSpatialEllipticalGauss::eval(const double& theta, const double& posangle, @@ -730,6 +733,10 @@ void GModelSpatialEllipticalGauss::free_members(void) * \f$a\f$ is the semi-major axis and * \f$b\f$ is the semi-minor axis of the ellipse. * + * @warning + * The normalization of the elliptical Gaussian is only valid in the small + * angle approximation. + * * @todo Generalize normalization to the sphere (for the moment only accurate * in the small angle approximation). ***************************************************************************/ -- libgit2 0.21.4