Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Gaussian Shape docs #209

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
History
=======

X.Y.Z (YYYY-MM-DD)
------------------
* Improve Gaussian Shape Documenation (:pr:`209`)


0.2.5 (2020-07-01)
------------------
* Convert WSClean Gaussian arcsecond and degree quantities to radians (:pr:`206`)
Expand Down
10 changes: 5 additions & 5 deletions africanus/model/shape/gaussian_shape.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,18 +60,18 @@ def impl(uvw, frequency, shape_params):

.. math::

& \lambda^\prime = 2 \lambda \pi \\
& \nu^\prime = \frac{\nu \pi}{2 c \sqrt{\log{2}}} \\
& r = \frac{e_{min}}{e_{maj}} \\
& u_{1} = (u \, e_{maj} \, cos(\alpha) - v \, e_{maj} \, sin(\alpha))
r \lambda^\prime \\
r \nu^\prime \\
& v_{1} = (u \, e_{maj} \, sin(\alpha) - v \, e_{maj} \, cos(\alpha))
\lambda^\prime \\
& \textrm{shape} = e^{(-u_{1}^2 - v_{1}^2)}
\nu^\prime \\
& \textrm{shape} = e^{(-(u_{1}^2) - (v_{1}^2))}

where:

- :math:`u` and :math:`v` are the UV coordinates and
:math:`\lambda` the frequency.
:math:`\nu` the frequency.
- :math:`e_{maj}` and :math:`e_{min}` are the major and minor axes
and :math:`\alpha` the position angle.

Expand Down