10000 JP-3781: Use center=False for compute_s_region_imaging by emolter · Pull Request #8897 · spacetelescope/jwst · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

JP-3781: Use center=False for compute_s_region_imaging #8897

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

Merged
merged 5 commits into from
Oct 18, 2024

Conversation

emolter
Copy link
Collaborator
@emolter emolter commented Oct 17, 2024

Resolves JP-3781

Closes #8896

This PR addresses a bug that makes the s_region for imaging data slightly incorrect. During testing of AL-837, it was discovered that the footprint encoded in model.meta.wcsinfo.s_region is not the same as what you get from wcs.footprint(). By default in the pipeline, the s_region is currently calculated as the center of each corner pixel of the footprint using stcal.alignment.util.compute_sregion_imaging(wcs, center=True), but it should calculate the true corners of the footprint using the same function but using the option center=False. There is even a comment in that function stating that center=False is usually what is desired.

The change is a one-liner, but a fairly large number of regression test failures are expected.

Tasks

  • request a review from someone specific, to avoid making the maintainers review every PR
  • add a build milestone, i.e. Build 11.3 (use the latest build if not sure)
  • Does this PR change user-facing code / API? (if not, label with no-changelog-entry-needed)
    • write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see below for change types)
    • update or add relevant tests
    • update relevant docstrings and / or docs/ page
    • start a regression test and include a link to the running job (click here for instructions)
      • Do truth files need to be updated ("okified")?
        • after the reviewer has approved these changes, run okify_regtests to update the truth files
  • if a JIRA ticket exists, make sure it is resolved properly
news fragment change types...
  • changes/<PR#>.general.rst: infrastructure or miscellaneous change
  • changes/<PR#>.docs.rst
  • changes/<PR#>.stpipe.rst
  • changes/<PR#>.datamodels.rst
  • changes/<PR#>.scripts.rst
  • changes/<PR#>.fits_generator.rst
  • changes/<PR#>.set_telescope_pointing.rst
  • changes/<PR#>.pipeline.rst

stage 1

  • changes/<PR#>.group_scale.rst
  • changes/<PR#>.dq_init.rst
  • changes/<PR#>.emicorr.rst
  • changes/<PR#>.saturation.rst
  • changes/<PR#>.ipc.rst
  • changes/<PR#>.firstframe.rst
  • changes/<PR#>.lastframe.rst
  • changes/<PR#>.reset.rst
  • changes/<PR#>.superbias.rst
  • changes/<PR#>.refpix.rst
  • changes/<PR#>.linearity.rst
  • changes/<PR#>.rscd.rst
  • changes/<PR#>.persistence.rst
  • changes/<PR#>.dark_current.rst
  • changes/<PR#>.charge_migration.rst
  • changes/<PR#>.jump.rst
  • changes/<PR#>.clean_flicker_noise.rst
  • changes/<PR#>.ramp_fitting.rst
  • changes/<PR#>.gain_scale.rst

stage 2

  • changes/<PR#>.assign_wcs.rst
  • changes/<PR#>.badpix_selfcal.rst
  • changes/<PR#>.msaflagopen.rst
  • changes/<PR#>.nsclean.rst
  • changes/<PR#>.imprint.rst
  • changes/<PR#>.background.rst
  • changes/<PR#>.extract_2d.rst
  • changes/<PR#>.master_background.rst
  • changes/<PR#>.wavecorr.rst
  • changes/<PR#>.srctype.rst
  • changes/<PR#>.straylight.rst
  • changes/<PR#>.wfss_contam.rst
  • changes/<PR#>.flatfield.rst
  • changes/<PR#>.fringe.rst
  • changes/<PR#>.pathloss.rst
  • changes/<PR#>.barshadow.rst
  • changes/<PR#>.photom.rst
  • changes/<PR#>.pixel_replace.rst
  • changes/<PR#>.resample_spec.rst
  • changes/<PR#>.residual_fringe.rst
  • changes/<PR#>.cube_build.rst
  • changes/<PR#>.extract_1d.rst
  • changes/<PR#>.resample.rst

stage 3

  • changes/<PR#>.assign_mtwcs.rst
  • changes/<PR#>.mrs_imatch.rst
  • changes/<PR#>.tweakreg.rst
  • changes/<PR#>.skymatch.rst
  • changes/<PR#>.exp_to_source.rst
  • changes/<PR#>.outlier_detection.rst
  • changes/<PR#>.tso_photometry.rst
  • changes/<PR#>.stack_refs.rst
  • changes/<PR#>.align_refs.rst
  • changes/<PR#>.klip.rst
  • changes/<PR#>.spectral_leak.rst
  • < 8000 code class="notranslate">changes/<PR#>.source_catalog.rst
  • changes/<PR#>.combine_1d.rst
  • changes/<PR#>.ami.rst

other

  • changes/<PR#>.wfs_combine.rst
  • changes/<PR#>.white_light.rst
  • changes/<PR#>.cube_skymatch.rst
  • changes/<PR#>.engdb_tools.rst
  • changes/<PR#>.guider_cds.rst

@emolter
Copy link
Collaborator Author
emolter commented Oct 17, 2024

@melanieclarke
Copy link
Collaborator

Quick question - I believe cube_build already uses S_REGION to get spatial footprints for IFU data. Does this change impact that mode?

@jemorrison
Copy link
Collaborator

Ok interesting. Cube_build does use the S_REGIONS. S_REGIONS is filled in in assign_wcs right ? Should it be updated there so downstream steps get the correct values ?

@emolter
Copy link
Collaborator Author
emolter commented Oct 17, 2024

Quick question - I believe cube_build already uses S_REGION to get spatial footprints for IFU data. Does this change impact that mode?

This only impacts anything that uses update_s_region_imaging, which is called in assign_wcs on IMAGING_TYPES, in ResampleStep but not ResampleSpecStep for the result model(s), and in tweakreg when applying the tweakreg solution. So I don't believe IFU data are impacted at all.

@emolter emolter changed the title use center=False for compute_s_region_imaging JP-3781: Use center=False for compute_s_region_imaging Oct 17, 2024
Copy link
codecov bot commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.85%. Comparing base (5243d0b) to head (1683c76).
Report is 476 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8897      +/-   ##
==========================================
+ Coverage   61.80%   61.85%   +0.04%     
==========================================
  Files         377      377              
  Lines       38824    38873      +49     
==========================================
+ Hits        23994    24043      +49     
  Misses      14830    14830              

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

@emolter emolter added this to the Build 11.2 milestone Oct 17, 2024
@emolter
Copy link
Collaborator Author
emolter commented Oct 17, 2024

all regression test failures (aside from the 4 also on the main branch) pertain to S_REGION keywords, and all appear to be the magnitude we would expect. Marking this ready for review.

@emolter emolter marked this pull request as ready for review October 17, 2024 16:01
@emolter emolter requested a review from a team as a code owner October 17, 2024 16:01
Copy link
Collaborator
@mairanteodoro mairanteodoro 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.
Thanks, @emolter!

Copy link
Collaborator
@nden nden left a comment

Choose a reason for hiding this comment

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

LGTM, just aminor comment about the log message.

emolter and others added 2 commits October 17, 2024 18:09
Co-authored-by: Nadia Dencheva <nadia.astropy@gmail.com>
@emolter
Copy link
Collaborator Author
emolter commented Oct 17, 2024

restarting regression tests here on Github Actions, now that the last of the differences have been ok-ified there and the okify script operates there

8000

@jemorrison
Copy link
Collaborator

I looked over the modules in assign_wcs.py util.py that deal with spectral data. The way they are designed I agree with you that I do not think this is an issue for spectral data. Not IFU nor NIRSpec slit data.

Copy link
Collaborator
@jemorrison jemorrison left a comment

Choose a reason for hiding this comment

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

Nice catch.
Looks good

@emolter emolter merged commit c275fa6 into spacetelescope:main Oct 18, 2024
31 checks passed
@emolter emolter deleted the JP-3781 branch October 18, 2024 13:37
hayescr pushed a commit to hayescr/jwst that referenced this pull request Oct 29, 2024
…e#8897)

Co-authored-by: Nadia Dencheva <nadia.astropy@gmail.com>
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.

s_region from header is inconsistent with s_region from wcs.footprint()
5 participants
0