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

add support for scientific notation in unit string #3200

Merged

Conversation

gibsongreen
Copy link
Contributor

@gibsongreen gibsongreen commented Sep 23, 2024

Description

This pull request is to address when scientific notation (a scale factor), is included in the native unit of the data file parsed (eg. in a MANGA cube). It is addressed by updating the values of the data to reflect the scale factor, and in the Unit Conversion plugin/app-wide, 'removing' the scale factor from the actual unit. When viewing the BUNIT metadata, the scale factor is still included in the unit.

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)?

@github-actions github-actions bot added cubeviz plugin Label for plugins common to multiple configurations labels Sep 23, 2024
@gibsongreen gibsongreen modified the milestone: 4.0 Sep 23, 2024
@gibsongreen gibsongreen changed the title add support for scientific notation in unit string, update associated… add support for scientific notation in unit string Sep 23, 2024
Copy link

codecov bot commented Sep 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.50%. Comparing base (32bb09e) to head (783db28).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3200   +/-   ##
=======================================
  Coverage   88.50%   88.50%           
=======================================
  Files         124      124           
  Lines       18577    18579    +2     
=======================================
+ Hits        16441    16443    +2     
  Misses       2136     2136           

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

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.

LGTM - love the simplicity!

@@ -199,6 +199,10 @@ def _return_spectrum_with_correct_units(flux, wcs, metadata, data_type,
if uncertainty is not None:
uncertainty = uncertainty / (u.pix * u.pix)

# handle scale factors when they are included in the unit
if not np.isclose(flux.unit.scale, 1.0, rtol=1e-5):
Copy link
Member

Choose a reason for hiding this comment

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

my only concern here is if there was a case that fell within the tolerance because of an actual scale in the unit, but I don't think that's a realistic real-case scenario and this is probably a better idea than checking ==1 anyways.

@gibsongreen gibsongreen marked this pull request as draft September 24, 2024 18:15
@kecnry
Copy link
Member

kecnry commented Sep 24, 2024

Pausing this for a bit since #3192 would technically avoid the need for this by adding the native units into the list of choices for flux display units. I still think we might want this, but let's test this vs #3192 vs the combination of the two and decide the pros/cons before merging.

@kecnry kecnry mentioned this pull request Sep 26, 2024
11 tasks
@gibsongreen gibsongreen marked this pull request as ready for review September 26, 2024 14:43
@gibsongreen gibsongreen merged commit b4fe650 into spacetelescope:main Sep 26, 2024
20 of 22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cubeviz plugin Label for plugins common to multiple configurations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants