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

RCAL-509: Update jump step docs #1035

Merged

Conversation

WilliamJamieson
Copy link
Collaborator

Resolves RCAL-509

Closes #760

This PR adds documentation for the uneven jump detection algorithm.

Checklist

  • added entry in CHANGES.rst under the corresponding subsection
  • updated relevant tests
  • updated relevant documentation
  • updated relevant milestone(s)
  • added relevant label(s)
  • ran regression tests, post a link to the Jenkins job below. How to run regression tests on a PR

@github-actions github-actions bot added documentation Improvements or additions to documentation ramp_fitting jump labels Nov 30, 2023
Copy link

codecov bot commented Nov 30, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.94%. Comparing base (1393865) to head (15e773a).
Report is 480 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1035   +/-   ##
=======================================
  Coverage   70.94%   70.94%           
=======================================
  Files         105      105           
  Lines        6979     6979           
=======================================
  Hits         4951     4951           
  Misses       2028     2028           
Flag Coverage Δ *Carryforward flag
nightly 63.06% <ø> (ø) Carriedforward from 1393865

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@WilliamJamieson WilliamJamieson marked this pull request as ready for review December 4, 2023 18:16
@WilliamJamieson WilliamJamieson requested a review from a team as a code owner December 4, 2023 18:16
Copy link
Collaborator

@schlafly schlafly left a comment

Choose a reason for hiding this comment

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

I added a few comments in line, but this looks good to me.

docs/roman/ramp_fitting/description.rst Show resolved Hide resolved
docs/roman/ramp_fitting/description.rst Outdated Show resolved Hide resolved
docs/roman/ramp_fitting/description.rst Outdated Show resolved Hide resolved
docs/roman/ramp_fitting/description.rst Show resolved Hide resolved
docs/roman/ramp_fitting/description.rst Show resolved Hide resolved
Copy link
Collaborator

@schlafly schlafly left a comment

Choose a reason for hiding this comment

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

One dumb in-line comment that was my mistake; approved.

If the uneven-ramp jump detection algorithm is turned on (the default), the ramp fitting
algorithm is then run iteratively on a "queue" (list) of ramps. The queue is initialized
with the ramp(s).
Then following the algorithm presented in Sanjib et al (2023) (in preparation),
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Then following the algorithm presented in Sanjib et al (2023) (in preparation),
Then following the algorithm presented in Sharma et al (2023) (in preparation),

@WilliamJamieson WilliamJamieson merged commit afbf5c1 into spacetelescope:main Dec 7, 2023
28 checks passed
@WilliamJamieson WilliamJamieson deleted the feature/jump_docs branch December 7, 2023 19:29
ddavis-stsci added a commit to ddavis-stsci/romancal that referenced this pull request Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation jump ramp_fitting
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for jump detection
2 participants