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/update the documentation for CALWF3 and associated standalone functions #67

Open
mdlpstsci opened this issue Apr 24, 2022 · 2 comments
Assignees

Comments

@mdlpstsci
Copy link
Contributor

The current on-line documentation for calwf3, as well as its components which can be run in standalone mode, is incorrect and out-of-date. The documentation and any associated diagrams need to be updated to reflect the true state of the pipeline software. This issue is related to Git PR#61. This issue is scheduled as JIRA HLA-759.

@mackjenn
Copy link
Contributor

Currently, readthedocs lists UVIS steps in a bulleted list (below Fig 3), with 'Unit conversion' coming just before FLASHCORR, which is incorrect.

Below that is a section called 'Unit Conversion to Electrons', which states:
The UVIS image is multiplied by gain right after BIASCORR, converting it to ELECTRONS. This step is no longer embedded within FLATCORR.

This is also incorrect, since it's applied after FLATCORR. Your testing notes on this were in the discussion on the Saturation Maps issue 558

We also discovered that the reference files FLSHFILE, SINKFILE, DARKFILE are in units of either electrons or electrons/sec, and that calwf3 applies the gain to these files before correcting the data which is still in units of DN.

I'm tagging @starivera on this ticket for followup. Do we need to open a new ticket separate from the SATUFILE discussion to update readthedocs?

@mdlpstsci
Copy link
Contributor Author

@mackjenn No. We can use this ticket and associated PR #68. Thank you for the reminder on these issues. I will schedule the doc update for the next sprint.

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

No branches or pull requests

2 participants