Skip to content

Commit

Permalink
slight modification in docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
ismael-mendoza committed Dec 12, 2024
1 parent 9097693 commit 3ec8153
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions bpd/prior.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
def ellip_mag_prior(e_mag: ArrayLike, sigma: float) -> ArrayLike:
"""Prior for the magnitude of the ellipticity with domain (0, 1).
This distribution is slightly modified from Gary's 2013 paper on Bayesian shear inference.
This distribution corresponds to Gary's 2013 paper on Bayesian shear inference.
Importantly, the paper did not include an additional factor of |e| that is needed
make this the correct expression for a Gaussian in `polar` coordinates. We include
this factor in this equation. This blog post is helpful: https://andrewcharlesjones.github.io/journal/rayleigh.html
this factor in this equation. This blog post is helpful: https://andrewcharlesjones.github.io/journal/rayleigh.html.
The additional factor of (1-e^2)^2 introduced by Gary guarantees differentiability
at e = 0 and e = 1.
Expand Down

0 comments on commit 3ec8153

Please sign in to comment.