Enable multiselect in subset plugin for recentering #2430

javerbukh · 2023-09-07T14:19:11Z

Description

This pull request adds multiselect support to the subset plugin for the purposes of recentering in Imviz.

Demo:

subset_plugin_multiselect_demo_2_09082023.mp4

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.
Adds multiselect support to the subset plugin for recentering.

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.
After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

codecov · 2023-09-07T18:10:42Z

Codecov Report

Patch coverage is 90.21% of modified lines.

❗ Current head 1d95e26 differs from pull request most recent head 91826e3. Consider uploading reports for the commit 91826e3 to get more accurate results

Files Changed	Coverage
jdaviz/core/template_mixin.py	`82.35%`
...igs/default/plugins/subset_plugin/subset_plugin.py	`91.66%`
jdaviz/configs/imviz/tests/test_subset_centroid.py	`100.00%`
.../plugins/line_analysis/tests/test_line_analysis.py	`100.00%`

📢 Thoughts on this report? Let us know!.

kecnry · 2023-09-07T18:28:33Z

jdaviz/configs/default/plugins/subset_plugin/subset_plugin.py

@@ -94,7 +101,7 @@ def _sync_selected_from_state(self, *args):

    def _on_subset_update(self, *args):
        self._sync_selected_from_state(*args)
-        if self.subset_selected == 'Create New':
+        if 'Create New' in self.subset_selected:


this could give us problems if we ever support subset renaming 🐱. (I don't think there's anything needed to be done here for now, just something to keep in mind for later)

jdaviz/configs/default/plugins/subset_plugin/subset_plugin.py

jdaviz/configs/default/plugins/subset_plugin/subset_plugin.vue

jdaviz/core/template_mixin.py

pllim · 2023-09-07T22:42:19Z

This alternate PR is definitely much cleaner. Thanks for your patience!

pllim · 2023-09-07T22:43:51Z

p.s. I cannot find a PR for your other approach. Am I going crazy?

javerbukh · 2023-09-08T13:03:14Z

@pllim I appreciate all the feedback to get to here! I did not make a PR for that implementation, you are still sane!

pllim · 2023-09-08T14:02:25Z

I'll test this when it is out of draft.

javerbukh · 2023-09-08T18:22:40Z

@pllim Had to fix a bug that I noticed when exiting multiselect and switching subsets. Should be ready for a review now! I'll work on updating the documentation in the meantime.

jdaviz/configs/imviz/tests/test_subset_centroid.py

jdaviz/tests/test_subsets.py

pllim · 2023-09-08T21:31:44Z

jdaviz/tests/test_subsets.py

+    for _ in range(5):
+        subset_plugin.vue_recenter_subset()
+
+    assert_allclose(subset_plugin.get_center("Subset 2"), (145.593022, 172.515541))


Should also check for new center of Subset 1.

pllim

Some minor comments above. Seems to work well for Imviz.

However, I see the multiselect option available in Cubeviz, which does not make sense, because there is no recentering in Cubeviz.

kecnry · 2023-09-11T12:30:08Z

jdaviz/core/template_mixin.py

@@ -1517,12 +1523,24 @@ def selected_obj(self):

    @property
    def selected_subset_state(self):
+        if self.is_multiselect:
+            subset_states = {}


I don't think other instances of multiselect return dictionaries... but since this is not terribly public-facing, this is probably ok for now and we can consider later whether to make everything dictionaries or lists.

Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com>

kecnry

Will it be confusing for users that the subset information disappears in multiselect mode? Should we add an in-plugin message explaining why? How about that the centering section is still enabled when no subsets are selected? Maybe we need to wait to get user feedback and can consider these edge-cases as possible future improvements.

There are also some behaviors with the multiselect that we might need to tweak and iterate as we begin to adopt it into other plugins as well, but that can definitely be deferred until we begin that work. Overall it seems to work quite well for this use case 🤞

pllim · 2023-09-11T13:01:36Z

My comments on it existing in Cubeviz and additional test assert were not addressed, so I will withhold approval for now.

pllim

Thanks, all!

) * Enable multiselect in subset plugin for recentering * Fix bug with default text * Remove unused import * Fix bug in aperature photometry * Address review comments * Remove commented out code * Add initial tests * Fix bug when exiting multiselect and switching subsets * Add documentation and update CHANGES file * Remove print statement * Add comment about recentering taking multiple iterations to docs * fix chip styling in subset dropdown * only set selected_has_subregions if exists * only show multiselect toggle in imviz * Apply suggestions from code review Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com> --------- Co-authored-by: Kyle Conroy <kyleconroy@gmail.com> Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com>

fix event handling for choosing config from launcher filepath fallback when object from config-detection fails to load fix: support for notebook 7 (spacetelescope#2420) Notebook 7 requires a different way to detect if the app runs in a notebook context. Fix explanation in markdown cell. DOC: Footprints plugin API docs (spacetelescope#2426) * build footprints API docs * add code snippet in plugin docs * fix syntax in API docs --------- Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com> prevent overwriting user-API methods (spacetelescope#2425) fix default color for overlay when traitlet set by user * for the FIRST overlay, the user could have set the color traitlet before the internal overlay object is created (which occurs as soon as the plugin is first shown). In that case, we want to respect the user choice of color. similar fixes for any other traitlet when plugin inactive regression test change log entry fix API import of single region and overwriting existing entry * along with regression testing TST: Also pull in scikit-image dev to get rid of incompatibility with numpy Use new "true circle" tool from glue-jupyter (spacetelescope#2332) * Use truecircle tool from glue-viz/glue-jupyter#376 * MNT: Bump glue-jupyter minversion that can use this new tool * Add change log * Fix line too long * Fix change log verbiage Co-authored-by: Kyle Conroy <kyleconroy@gmail.com> --------- Co-authored-by: Kyle Conroy <kyleconroy@gmail.com> Enable multiselect in subset plugin for recentering (spacetelescope#2430) * Enable multiselect in subset plugin for recentering * Fix bug with default text * Remove unused import * Fix bug in aperature photometry * Address review comments * Remove commented out code * Add initial tests * Fix bug when exiting multiselect and switching subsets * Add documentation and update CHANGES file * Remove print statement * Add comment about recentering taking multiple iterations to docs * fix chip styling in subset dropdown * only set selected_has_subregions if exists * only show multiselect toggle in imviz * Apply suggestions from code review Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com> --------- Co-authored-by: Kyle Conroy <kyleconroy@gmail.com> Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com> Debug standalone build (spacetelescope#2441) * Log jdaviz output for debugging * Run workflow on debugging branch * See if collecting data from jupyter-client will fix this, otherwise might need to downgrade * Remove debugging stuff MNT: Bump actions/checkout to v4 Enable workflow_dispatch for standalone because it cannot be enabled outside of main apparently [ci skip] [rtd skip] EXP: Update workflow versions Fix Mosviz slit overlay (spacetelescope#2434) * Fix Mosviz slit overlay by using polygon instead of forcing a rectangle without angle info. Co-authored-by: Camilla Pacifici <camilla.pacifici@gmail.com> * Off by one error in predicted PR num --------- Co-authored-by: Camilla Pacifici <camilla.pacifici@gmail.com> API access (hidden) to disable cubeviz movie UI (spacetelescope#2440) * (hidden) API access to disable cubeviz movie UI * default movie_enabled based on new app-setting server_is_remote * test coverage TST: Ignore ASDF warning about gwcs-1.0.0 schema because gwcs dev and/or asdf-wcs-schemas 0.2.0 triggers the warning because the schema is no longer supported.

github-actions bot added specviz testing imviz labels Sep 7, 2023

javerbukh added plugin Label for plugins common to multiple configurations and removed specviz testing imviz labels Sep 7, 2023

Enable multiselect in subset plugin for recentering

87addc7

javerbukh force-pushed the subset-plugin-multiselect branch from 7b7f55b to 87addc7 Compare September 7, 2023 14:24

javerbukh added 3 commits September 7, 2023 10:59

Fix bug with default text

7124070

Remove unused import

1da5c25

Fix bug in aperature photometry

ebc504d

kecnry reviewed Sep 7, 2023

View reviewed changes

pllim added this to the 3.7 milestone Sep 7, 2023

pllim added the imviz label Sep 7, 2023

javerbukh added 4 commits September 8, 2023 10:10

Address review comments

a8c0bcd

Remove commented out code

2246d31

Add initial tests

225c3b9

Fix bug when exiting multiselect and switching subsets

37f32c3

javerbukh marked this pull request as ready for review September 8, 2023 18:22

javerbukh requested review from rosteen, bmorris3, haticekaratay and cshanahan1 as code owners September 8, 2023 18:22

javerbukh added 3 commits September 8, 2023 14:33

Add documentation and update CHANGES file

7d02403

Remove print statement

d73aa6c

Add comment about recentering taking multiple iterations to docs

1d95e26

pllim reviewed Sep 8, 2023

View reviewed changes

jdaviz/configs/imviz/tests/test_subset_centroid.py Outdated Show resolved Hide resolved

pllim reviewed Sep 8, 2023

View reviewed changes

jdaviz/tests/test_subsets.py Outdated Show resolved Hide resolved

pllim reviewed Sep 8, 2023

View reviewed changes

kecnry reviewed Sep 11, 2023

View reviewed changes

kecnry and others added 4 commits September 11, 2023 08:47

fix chip styling in subset dropdown

91c8ee4

only set selected_has_subregions if exists

b79710c

only show multiselect toggle in imviz

5edb1c2

Apply suggestions from code review

91826e3

Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com>

kecnry approved these changes Sep 11, 2023

View reviewed changes

pllim approved these changes Sep 11, 2023

View reviewed changes

pllim merged commit 0060d9f into spacetelescope:main Sep 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable multiselect in subset plugin for recentering #2430

Enable multiselect in subset plugin for recentering #2430

javerbukh commented Sep 7, 2023 •

edited

Loading

codecov bot commented Sep 7, 2023 •

edited

Loading

kecnry Sep 7, 2023

pllim commented Sep 7, 2023

pllim commented Sep 7, 2023

javerbukh commented Sep 8, 2023

pllim commented Sep 8, 2023

javerbukh commented Sep 8, 2023

pllim Sep 8, 2023

pllim left a comment

kecnry Sep 11, 2023

kecnry left a comment

pllim commented Sep 11, 2023

pllim left a comment

Enable multiselect in subset plugin for recentering #2430

Enable multiselect in subset plugin for recentering #2430

Conversation

javerbukh commented Sep 7, 2023 • edited Loading

Description

Change log entry

Checklist for package maintainer(s)

codecov bot commented Sep 7, 2023 • edited Loading

Codecov Report

kecnry Sep 7, 2023

Choose a reason for hiding this comment

pllim commented Sep 7, 2023

pllim commented Sep 7, 2023

javerbukh commented Sep 8, 2023

pllim commented Sep 8, 2023

javerbukh commented Sep 8, 2023

pllim Sep 8, 2023

Choose a reason for hiding this comment

pllim left a comment

Choose a reason for hiding this comment

kecnry Sep 11, 2023

Choose a reason for hiding this comment

kecnry left a comment

Choose a reason for hiding this comment

pllim commented Sep 11, 2023

pllim left a comment

Choose a reason for hiding this comment

javerbukh commented Sep 7, 2023 •

edited

Loading

codecov bot commented Sep 7, 2023 •

edited

Loading