refactor unit conversion messaging #3192

kecnry · 2024-09-12T15:35:17Z

Description

This pull request refactors and simplifies the messaging within unit conversion. ~~This currently is branched off of #3156, so should be moved onto main after that is merged.~~

TODO

Unskip test_spectrum_viewer_axis_labels from convert flux cubes to per-square-pixel surface brightness cubes #3156
Consolidate PIX2 vs u.pix * u.pix from convert flux cubes to per-square-pixel surface brightness cubes #3156

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

Don't grok most of the stuff. Just a general review. Thanks.

pllim · 2024-09-17T15:27:37Z

jdaviz/app.py

@@ -86,7 +86,16 @@ def equivalent_units(self, data, cid, units):
                    'erg / (s sr cm2)', 'erg / (Hz s sr cm2)',
                    'erg / (Angstrom s sr cm2)',
                    'ph / (Angstrom s sr cm2)', 'ph / (Hz s sr cm2)'
-                ])
+                ]
+                + [


Do we really need the + operators to chain multiple static lists here? This introduces unnecessary list math, no?

jdaviz/configs/cubeviz/plugins/parsers.py

jdaviz/configs/cubeviz/plugins/tests/test_cubeviz_aperphot.py

pllim · 2024-09-17T15:41:10Z

jdaviz/configs/default/plugins/model_fitting/tests/test_fitting.py

-    assert flux_sci.units == flux_unit_str
+    # now that the flux cube was loaded into cubeviz, there will be a factor
+    # of pix2 applied to the flux unit
+    assert flux_sci.units == flux_unit_str + ' / pix2'


Suggested change

assert flux_sci.units == flux_unit_str + ' / pix2'

assert flux_sci.units == f'{flux_unit_str} / pix2'

changed this in 3156

jdaviz/configs/default/plugins/model_fitting/tests/test_plugin.py

pllim · 2024-09-17T15:50:38Z

jdaviz/configs/imviz/plugins/coords_info/coords_info.py

+                # If unit is flux per pix2, the type will be 'unknown' rather
+                # than surface brightness, so have to multiply the pix2 part out
+                # and check if the numerator is a spectral flux density
+                if check_if_unit_is_per_solid_angle(unit, return_unit=True) == u.pix*u.pix:


Should we move PIX2 higher up and re-use it throughout the package instead of u.pix*u.pix?

I'll do this after all these PRs are merged to avoid conflicts

pllim · 2024-09-17T15:53:42Z

jdaviz/tests/test_utils.py

@@ -15,6 +15,8 @@

 PHOTUTILS_LT_1_12_1 = not minversion(photutils, "1.12.1.dev")

+PIX2 = u.pix * u.pix


Do not need to re-define this in multiple places if we move it higher up.

jdaviz/utils.py

pllim · 2024-09-17T18:17:04Z

jdaviz/configs/specviz/plugins/unit_conversion/unit_conversion.py

+
+        elif axis == 'time':
+            pass


Not needed?

Suggested change

elif axis == 'time':

pass

probably not, I can replace with a comment if you'd rather. It's here just to remind us that time is not currently handled (even though it can exist).

Comment would be less confusing unless you intend to throw warning or exception.

This reverts commit aa0d384.

kecnry added this to the 4.0 milestone Sep 12, 2024

github-actions bot added cubeviz specviz testing imviz plugin Label for plugins common to multiple configurations labels Sep 12, 2024

kecnry force-pushed the unit-conv-messaging branch from 4cfaeed to 9293060 Compare September 12, 2024 15:43

kecnry changed the title ~~refactor unit conv messaging~~ refactor unit conversion messaging Sep 12, 2024

kecnry force-pushed the unit-conv-messaging branch from 55c36a8 to 18e1562 Compare September 12, 2024 17:32

camipacifici mentioned this pull request Sep 12, 2024

convert flux cubes to per-square-pixel surface brightness cubes #3156

Merged

kecnry force-pushed the unit-conv-messaging branch 8 times, most recently from 405a11d to cee44db Compare September 16, 2024 15:43

pllim reviewed Sep 17, 2024

View reviewed changes

kecnry mentioned this pull request Sep 18, 2024

fix formatting of unit after appending angle #3198

Closed

kecnry force-pushed the unit-conv-messaging branch 3 times, most recently from 91ac1c5 to d54cef4 Compare September 19, 2024 11:59

kecnry added 6 commits September 20, 2024 15:49

WIP: refactor/simplify messaging and logic in unit conversion

e19c6ca

generalized solution in place of spacetelescope#3185

2f983b8

code cleanup

34ecec0

generalized solution in place of spacetelescope#3177

8f0cf5e

update slice plugin to handle new messaging order

4c4e33b

generalize initializing options to also act on first valid data

b6d7847

kecnry added 3 commits September 20, 2024 15:50

code cleanup

6bd32ad

fix test failures

8507eb8

Revert "skip test in parsers"

9d04c43

This reverts commit aa0d384.

kecnry force-pushed the unit-conv-messaging branch from d54cef4 to 9d04c43 Compare September 20, 2024 19:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor unit conversion messaging #3192

refactor unit conversion messaging #3192

kecnry commented Sep 12, 2024 •

edited

Loading

pllim left a comment

pllim Sep 17, 2024

pllim Sep 17, 2024

cshanahan1 Sep 18, 2024

pllim Sep 17, 2024

cshanahan1 Sep 18, 2024

pllim Sep 17, 2024

pllim Sep 17, 2024

kecnry Sep 18, 2024

pllim Sep 18, 2024

	assert flux_sci.units == flux_unit_str + ' / pix2'
	assert flux_sci.units == f'{flux_unit_str} / pix2'

		@@ -15,6 +15,8 @@

		PHOTUTILS_LT_1_12_1 = not minversion(photutils, "1.12.1.dev")

		PIX2 = u.pix * u.pix

refactor unit conversion messaging #3192

Are you sure you want to change the base?

refactor unit conversion messaging #3192

Conversation

kecnry commented Sep 12, 2024 • edited Loading

Description

TODO

Change log entry

Checklist for package maintainer(s)

pllim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kecnry commented Sep 12, 2024 •

edited

Loading