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 logic flow in _parse_hdulist for Cubeviz #2842

Merged
merged 1 commit into from
May 2, 2024

Conversation

pllim
Copy link
Contributor

@pllim pllim commented May 1, 2024

Description

Noticed these while investigating something else. Technically a bug but it is buried so deeply in the internals I don't think users would notice, so probably don't need a change log.

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)? 👻

@pllim pllim added bug Something isn't working trivial Only needs one approval instead of two no-changelog-entry-needed changelog bot directive labels May 1, 2024
@pllim pllim added this to the 3.10 milestone May 1, 2024
@github-actions github-actions bot added cubeviz plugin Label for plugins common to multiple configurations labels May 1, 2024
@@ -257,15 +257,13 @@ def _parse_hdulist(app, hdulist, file_name=None,
if hdu.name != 'PRIMARY' and 'PRIMARY' in hdulist:
metadata[PRIHDR_KEY] = standardize_metadata(hdulist['PRIMARY'].header)

sc = _return_spectrum_with_correct_units(flux, wcs, metadata, data_type, hdulist=hdulist)

# store original WCS in metadata. this is a hacky workaround for converting subsets
# to sky regions, where the parent data of the subset might have dropped spatial WCS info
metadata['_orig_spatial_wcs'] = _get_celestial_wcs(wcs)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was added in #2496 by @cshanahan1 . I think the metadata change here was a bit too late; should have been done before being passed into sc.

app.add_data(sc, data_label)
if data_type == 'flux': # Forced wave unit conversion made it lose stuff, so re-add
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This one was blamed to me back in #1480 but I have no recollection writing it... It was @javerbukh's PR so maybe he remembers why we did it this way or whether we can move it further down. 🤷‍♀️

Copy link

codecov bot commented May 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.95%. Comparing base (95cf7f2) to head (9b4817d).
Report is 10 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2842      +/-   ##
==========================================
+ Coverage   88.94%   88.95%   +0.01%     
==========================================
  Files         111      111              
  Lines       17101    17101              
==========================================
+ Hits        15211    15213       +2     
+ Misses       1890     1888       -2     

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

@pllim pllim modified the milestone: 3.10 May 1, 2024
Copy link
Member

@kecnry kecnry left a comment

Choose a reason for hiding this comment

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

Thanks for the cleanup and tracing down the history. I think this all looks safe! 🤷‍♂️ 🤞

@pllim pllim merged commit 53f3641 into spacetelescope:main May 2, 2024
24 of 26 checks passed
@pllim pllim deleted the cubeviz-hdulist-parser-cleanup branch May 2, 2024 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working cubeviz no-changelog-entry-needed changelog bot directive plugin Label for plugins common to multiple configurations trivial Only needs one approval instead of two
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants