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

JP-2071: Update ramp_fit to toggle one-group slope calculations #6737

Merged
merged 8 commits into from
Mar 8, 2022

Conversation

kmacdonald-stsci
Copy link
Contributor

@kmacdonald-stsci kmacdonald-stsci commented Feb 18, 2022

Closes #6013
Resolves JP-2071

Description

A suppress_one_group boolean variable has been added as a parameter to the ramp fitting step class.

When true (the default) saturated ramps with only the 0th group being good will be treated as completely saturated ramps. The calculations will be done as if all calculations are saturated, but the DQ flags will be set as if the first group is good, i.e., the pixel DQ will not have DO_NOT_USE set.

When false saturated ramps with only the 0th group being good will be treated as the normal special case of having only one good group.

Many unit tests are expected to fail until the corresponding PR in STCAL has been merged.

Checklist

  • Tests
  • Documentation
  • Change log
  • Milestone
  • Label(s)

@hbushouse hbushouse changed the title Jp 2071 sat JP-2071: Update ramp_fit to toggle one-group slope calculations Feb 18, 2022
@hbushouse hbushouse added this to the Build 8.0 milestone Feb 18, 2022
Copy link
Collaborator

@hbushouse hbushouse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks OK. Just needs a couple minor updates before finalizing.

Copy link
Contributor

@dmggh dmggh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Just a couple of minor docs comments.

Copy link
Collaborator

@hbushouse hbushouse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I guess we have to merge the stcal PR first and then this one?

@hbushouse
Copy link
Collaborator

It occurs to me that the docs for the ramp_fit step will also need to be updated to list this new argument and what it does.

@kmacdonald-stsci
Copy link
Contributor Author

I updated the arguments.rst documentation for ramp fitting.

@codecov
Copy link

codecov bot commented Mar 8, 2022

Codecov Report

Merging #6737 (0d3c9f1) into master (faf115a) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #6737   +/-   ##
=======================================
  Coverage   74.55%   74.56%           
=======================================
  Files         413      413           
  Lines       36421    36440   +19     
=======================================
+ Hits        27154    27170   +16     
- Misses       9267     9270    +3     
Flag Coverage Δ *Carryforward flag
nightly 74.54% <ø> (ø) Carriedforward from faf115a
unit 52.61% <ø> (+<0.01%) ⬆️

*This pull request uses carry forward flags. Click here to find out more.

Impacted Files Coverage Δ
jwst/ramp_fitting/ramp_fit_step.py 96.36% <ø> (-1.44%) ⬇️
jwst/transforms/integration.py 76.47% <0.00%> (-5.89%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update faf115a...0d3c9f1. Read the comment docs.

@hbushouse
Copy link
Collaborator

Failure in CI for oldest dependencies is due to the use of stcal 0.6.0, which does not support the new "suppress_one_group" step param. It is supported in stcal 0.6.1, which is used in the other passing CI tests.

@hbushouse hbushouse merged commit b3d0bdf into spacetelescope:master Mar 8, 2022
@kmacdonald-stsci kmacdonald-stsci deleted the jp_2071_sat branch April 1, 2022 13:54
tapastro pushed a commit to tapastro/jwst that referenced this pull request Apr 26, 2022
…etelescope#6737)

* Modify step code to add switch for one group suppression and unit tests for the switch
.

* Adding changes to the change log.

* Making changes due to code review.

* Making changes due to code review.

* Making changes due to code review.

* Changing tests for DQ flag computation changes.

* Updating the arguments to the ramp fit step to acount for the new argument for the new feature.

Co-authored-by: Howard Bushouse <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add ramp_fit parameter to turn on/off one-group slope calculations
3 participants