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

Inconsistent documentation for Gaussian shape function #207

Open
landmanbester opened this issue Jul 6, 2020 · 0 comments · May be fixed by #209
Open

Inconsistent documentation for Gaussian shape function #207

landmanbester opened this issue Jul 6, 2020 · 0 comments · May be fixed by #209

Comments

@landmanbester
Copy link
Collaborator

It has just come to my attention that the formulae in the docs (https://codex-africanus.readthedocs.io/en/latest/model-api.html) do not match up with what is actually computed in the function

https://github.com/ska-sa/codex-africanus/blob/d4e4c01de1029e418f03c5fb096829a3202986b2/africanus/model/shape/gaussian_shape.py#L49

Look at the expression for v_1 compared to how it is defined in the code. Also, the docs refer to lambda as frequency and I am pretty sure it should be wavelength. There is also no mention of the scaling function that compensates for the fact that e_{min} and e_{maj} actually refer to the FWHM of the components (which is not the usual way to parametrise a Gaussian). It might be wise to update the docs to explain this parameterization a bit better.

@sjperkins sjperkins linked a pull request Jul 7, 2020 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant