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

Option to return complex wavefront is not documented & hard-to-find #279

Open
mperrin opened this issue Dec 10, 2018 · 4 comments
Open

Option to return complex wavefront is not documented & hard-to-find #279

mperrin opened this issue Dec 10, 2018 · 4 comments
Labels
Milestone

Comments

@mperrin
Copy link
Collaborator

mperrin commented Dec 10, 2018

In #234 (originally https://github.com/spacetelescope/mperrin/issues/234), @douglase added a feature suggested by @jlumbres: an option to return the complex wavefront instead of (in addition to?) returning the real-valued PSF.

This is useful, but not at all documented anywhere. @sdwill had no idea this feature existed but it would have been useful to him. Not immediately urgent but perhaps @sdwill, @douglase, @jlumbres, can some combination of you put together some brief docs on this, please? @sdwill can take the lead on coordinating that into a PR eventually.

@mperrin mperrin added the docs label Dec 10, 2018
@douglase
Copy link
Collaborator

There is some documentation of the feature in the description of propogate_mono(), are you thinking it should be described in an example or elsewhere?

@mperrin
Copy link
Collaborator Author

mperrin commented Dec 10, 2018

Some mention somewhere in the Sphinx docs perhaps? Not sure. I don't have a specific fix in mind.

But demonstrably we should probably do something since Scott asked for this feature and didn't realize you'd already implemented it... (Then again, part of the problem is the gradual complexification of this API over time, which makes it harder to convey or even state all of what's in there.)

@mperrin
Copy link
Collaborator Author

mperrin commented Dec 10, 2018

(More generally @douglase, it would be great if you could chat with @sdwill sometime. What you're both doing for WFIRST and LUVOIR modeling respectively has a lot of similarities, I think... )

@mperrin
Copy link
Collaborator Author

mperrin commented Dec 10, 2018

One possible place to put this in the docs would be this page: https://poppy-optics.readthedocs.io/en/latest/options.html

But that's still got a great solution. In part because the docs could use a more substantial overhaul...

@mperrin mperrin added this to the 0.8.1 milestone Apr 23, 2019
@mperrin mperrin modified the milestones: 0.9.0, 0.9.2 Jun 19, 2020
@mperrin mperrin modified the milestones: 1.0.0, 1.1.0 Jul 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants