diff --git a/CHANGES.rst b/CHANGES.rst
index 855d5736ce..4f3ae8a146 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -30,6 +30,8 @@ Imviz
- The stretch histogram is now downsampled for large images for improved performance. [#2408]
+- Add multiselect support to the subset plugin for recentering only. [#2430]
+
Mosviz
^^^^^^
diff --git a/docs/imviz/plugins.rst b/docs/imviz/plugins.rst
index 5d7118deb2..c2da960ffa 100644
--- a/docs/imviz/plugins.rst
+++ b/docs/imviz/plugins.rst
@@ -48,16 +48,19 @@ in the app-level toolbar. It might not show some static regions loaded
via the API unless an interactive region is drawn after.
If an existing subset is selected, the parameters of the subset will also be
-shown. Note that while parameters for compound regions (e.g., a subset with
-multiple disjoint regions) are displayed, the logical operations joining them
-(``OR``, ``AND``, etc.) are not shown.
-
-For a simple subset in Imviz only, you can choose to recenter it based
-on the selected Data. The centroid is calculated by
-:attr:`photutils.aperture.ApertureStats.centroid`, which is the
-center-of-mass of the data within the aperture.
+shown. Note that in addition to parameters for compound regions (e.g., a subset with
+multiple disjoint regions) being displayed, the logical operations joining them
+(``OR``, ``AND``, etc.) are shown as well for each region. This shows how all regions
+are added together to create the subset shown in the viewer.
+
+For a simple subset or group of subsets in Imviz only, you can choose to recenter based
+on the selected Data. To switch to multiselect mode, click the icon in the top right of
+the plugin and select multiple subsets from the drop-down menu.
+The centroid is calculated by :attr:`photutils.aperture.ApertureStats.centroid`,
+which is the center-of-mass of the data within the aperture.
No background subtraction is performed. Click :guilabel:`Recenter`
to change its parameters and move it to the calculated centroid.
+This may take multiple iterations to converge.
.. note::
diff --git a/jdaviz/components/plugin_subset_select.vue b/jdaviz/components/plugin_subset_select.vue
index 82e8ffd07d..b5a6709b78 100644
--- a/jdaviz/components/plugin_subset_select.vue
+++ b/jdaviz/components/plugin_subset_select.vue
@@ -10,20 +10,49 @@
:label="label ? label : 'Subset'"
:hint="hint ? hint : 'Select subset.'"
:rules="rules ? rules : []"
+ :multiple="multiselect"
+ :chips="multiselect"
item-text="label"
item-value="label"
persistent-hint
>
-
- {{ data.item.type=='spectral' ? 'mdi-chart-bell-curve' : 'mdi-chart-scatter-plot' }}
-
-
+
+
+
+ {{ data.item.type=='spectral' ? 'mdi-chart-bell-curve' : 'mdi-chart-scatter-plot' }}
+
+ {{ data.item.label }}
+
+
+
+
+ {{ data.item.type=='spectral' ? 'mdi-chart-bell-curve' : 'mdi-chart-scatter-plot' }}
+
{{ data.item.label }}
+
+
+
+
+ {{ selected.length == items.length ? 'mdi-close-box' : selected.length ? 'mdi-minus-box' : 'mdi-checkbox-blank-outline' }}
+
+
+
+
+ {{ selected.length < items.length ? "Select All" : "Clear All" }}
+
+
+
+
+
@@ -46,7 +75,7 @@
diff --git a/jdaviz/configs/default/plugins/subset_plugin/subset_plugin.py b/jdaviz/configs/default/plugins/subset_plugin/subset_plugin.py
index b62c7d6cf1..b1e00c65ef 100644
--- a/jdaviz/configs/default/plugins/subset_plugin/subset_plugin.py
+++ b/jdaviz/configs/default/plugins/subset_plugin/subset_plugin.py
@@ -8,7 +8,7 @@
from glue.core.edit_subset_mode import (AndMode, AndNotMode, OrMode,
ReplaceMode, XorMode)
from glue.core.roi import CircularROI, CircularAnnulusROI, EllipticalROI, RectangularROI
-from glue.core.subset import RoiSubsetState, RangeSubsetState
+from glue.core.subset import RoiSubsetState, RangeSubsetState, CompositeSubsetState
from glue.icons import icon_path
from glue_jupyter.widgets.subset_mode_vuetify import SelectionModeMenu
from glue_jupyter.common.toolbar_vuetify import read_icon
@@ -17,6 +17,7 @@
from jdaviz.core.events import SnackbarMessage, GlobalDisplayUnitChanged
from jdaviz.core.registries import tray_registry
from jdaviz.core.template_mixin import PluginTemplateMixin, DatasetSelectMixin, SubsetSelect
+from jdaviz.core.tools import ICON_DIR
__all__ = ['SubsetPlugin']
@@ -36,7 +37,8 @@ class SubsetPlugin(PluginTemplateMixin, DatasetSelectMixin):
template_file = __file__, "subset_plugin.vue"
select = List([]).tag(sync=True)
subset_items = List([]).tag(sync=True)
- subset_selected = Unicode("Create New").tag(sync=True)
+ subset_selected = Any().tag(sync=True)
+
mode_selected = Unicode('add').tag(sync=True)
show_region_info = Bool(True).tag(sync=True)
subset_types = List([]).tag(sync=True)
@@ -46,6 +48,7 @@ class SubsetPlugin(PluginTemplateMixin, DatasetSelectMixin):
subplugins_opened = Any().tag(sync=True)
+ multiselect = Bool(False).tag(sync=True)
is_centerable = Bool(False).tag(sync=True)
can_simplify = Bool(False).tag(sync=True)
@@ -55,6 +58,9 @@ class SubsetPlugin(PluginTemplateMixin, DatasetSelectMixin):
icon_xor = Unicode(read_icon(os.path.join(icon_path("glue_xor", icon_format="svg")), 'svg+xml')).tag(sync=True) # noqa
icon_andnot = Unicode(read_icon(os.path.join(icon_path("glue_andnot", icon_format="svg")), 'svg+xml')).tag(sync=True) # noqa
+ icon_radialtocheck = Unicode(read_icon(os.path.join(ICON_DIR, 'radialtocheck.svg'), 'svg+xml')).tag(sync=True) # noqa
+ icon_checktoradial = Unicode(read_icon(os.path.join(ICON_DIR, 'checktoradial.svg'), 'svg+xml')).tag(sync=True) # noqa
+
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
@@ -72,12 +78,13 @@ def __init__(self, *args, **kwargs):
self.subset_select = SubsetSelect(self,
'subset_items',
'subset_selected',
+ multiselect='multiselect',
default_text="Create New")
self.subset_states = []
self.spectral_display_unit = None
def _sync_selected_from_state(self, *args):
- if not hasattr(self, 'subset_select'):
+ if not hasattr(self, 'subset_select') or self.multiselect:
# during initial init, this can trigger before the component is initialized
return
if self.session.edit_subset_mode.edit_subset == []:
@@ -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:
return
self._get_subset_definition(*args)
subset_to_update = self.session.edit_subset_mode.edit_subset[0]
@@ -118,7 +125,6 @@ def _sync_selected_from_ui(self, change):
if not hasattr(self, 'subset_select'):
# during initial init, this can trigger before the component is initialized
return
-
if change['new'] != self.subset_select.default_text:
self._get_subset_definition(change['new'])
self.show_region_info = change['new'] != self.subset_select.default_text
@@ -131,7 +137,12 @@ def _unpack_get_subsets_for_ui(self):
Convert what app.get_subsets returns into something the UI of this plugin
can display.
"""
- subset_information = self.app.get_subsets(self.subset_selected, simplify_spectral=False,
+ if self.multiselect:
+ self.is_centerable = True
+ return
+
+ subset_information = self.app.get_subsets(self.subset_selected,
+ simplify_spectral=False,
use_display_units=True)
_around_decimals = 6 # Avoid 30 degrees from coming back as 29.999999999999996
if not subset_information:
@@ -248,6 +259,11 @@ def _get_subset_definition(self, *args):
self._unpack_get_subsets_for_ui()
def vue_simplify_subset(self, *args):
+ if self.multiselect:
+ self.hub.broadcast(SnackbarMessage("Cannot simplify spectral subset "
+ "when multiselect is active", color='warning',
+ sender=self))
+ return
if len(self.subset_states) < 2:
self.hub.broadcast(SnackbarMessage("Cannot simplify spectral subset "
"of length less than 2", color='warning',
@@ -265,6 +281,12 @@ def _on_display_unit_changed(self, msg):
self._get_subset_definition(self.subset_selected)
def vue_update_subset(self, *args):
+ if self.multiselect:
+ self.hub.broadcast(SnackbarMessage("Cannot update subset "
+ "when multiselect is active", color='warning',
+ sender=self))
+ return
+
status, reason = self._check_input()
if not status:
self.hub.broadcast(SnackbarMessage(reason, color='error', sender=self))
@@ -298,12 +320,27 @@ def vue_update_subset(self, *args):
setattr(sub_states, d_att["att"], d_val)
else:
setattr(sub_states.roi, d_att["att"], d_val)
+ self._push_update_to_ui()
+
+ def _push_update_to_ui(self, subset_name=None):
+ """
+ Forces the UI to update how it represents the subset.
+
+ Parameters
+ ----------
+ subset_name : str
+ The name of the subset that is being updated.
+
+ """
+ if not subset_name:
+ subset_name = self.subset_selected
try:
dc = self.data_collection
subsets = dc.subset_groups
- self.session.edit_subset_mode._combine_data(
- subsets[[x.label for x in subsets].index(self.subset_selected)].subset_state,
- override_mode=ReplaceMode)
+ subset_to_update = subsets[[x.label for x in subsets].index(subset_name)]
+ self.session.edit_subset_mode.edit_subset = [subset_to_update]
+ self.session.edit_subset_mode._combine_data(subset_to_update.subset_state,
+ override_mode=ReplaceMode)
except Exception as err: # pragma: no cover
self.hub.broadcast(SnackbarMessage(
f"Failed to update Subset: {repr(err)}", color='error', sender=self))
@@ -361,42 +398,63 @@ def vue_recenter_subset(self, *args):
from photutils.aperture import ApertureStats
from jdaviz.core.region_translators import regions2aperture, _get_region_from_spatial_subset
- try:
- reg = _get_region_from_spatial_subset(self, self.subset_select.selected_subset_state)
- aperture = regions2aperture(reg)
- data = self.dataset.selected_dc_item
- comp = data.get_component(data.main_components[0])
- comp_data = comp.data
- phot_aperstats = ApertureStats(comp_data, aperture, wcs=data.coords)
-
- # Sky region from WCS linking, need to convert centroid back to pixels.
- if hasattr(reg, "to_pixel"):
- # Centroid was calculated in selected data.
- # However, Subset is always defined w.r.t. its parent,
- # so we need to convert back.
- x, y = pixel_to_pixel(
- data.coords,
- self.subset_select.selected_subset_state.xatt.parent.coords,
- phot_aperstats.xcentroid,
- phot_aperstats.ycentroid)
+ def _do_recentering(subset, subset_state):
+ try:
+ reg = _get_region_from_spatial_subset(self, subset_state) # noqa
+ aperture = regions2aperture(reg)
+ data = self.dataset.selected_dc_item
+ comp = data.get_component(data.main_components[0])
+ comp_data = comp.data
+ phot_aperstats = ApertureStats(comp_data, aperture, wcs=data.coords)
+
+ # Sky region from WCS linking, need to convert centroid back to pixels.
+ if hasattr(reg, "to_pixel"):
+ # Centroid was calculated in selected data.
+ # However, Subset is always defined w.r.t. its parent,
+ # so we need to convert back.
+ x, y = pixel_to_pixel(
+ data.coords,
+ subset_state.xatt.parent.coords,
+ phot_aperstats.xcentroid,
+ phot_aperstats.ycentroid)
+ else:
+ x = phot_aperstats.xcentroid
+ y = phot_aperstats.ycentroid
+ if not np.all(np.isfinite((x, y))):
+ raise ValueError(f'Invalid centroid ({x}, {y})')
+ except Exception as err:
+ self.set_center(self.get_center(subset_name=subset), subset_name=subset,
+ update=False)
+ self.hub.broadcast(SnackbarMessage(
+ f"Failed to calculate centroid: {repr(err)}", color='error', sender=self))
else:
- x = phot_aperstats.xcentroid
- y = phot_aperstats.ycentroid
+ self.set_center((x, y), subset_name=subset, update=True)
- if not np.all(np.isfinite((x, y))):
- raise ValueError(f'Invalid centroid ({x}, {y})')
- except Exception as err:
- self.set_center(self.get_center(), update=False)
- self.hub.broadcast(SnackbarMessage(
- f"Failed to calculate centroid: {repr(err)}", color='error', sender=self))
+ dict_subset_to_state = self.subset_select.selected_subset_state
+ if not self.multiselect:
+ _do_recentering(self.subset_selected, dict_subset_to_state)
else:
- self.set_center((x, y), update=True)
-
- def get_center(self):
+ for sub in self.subset_selected:
+ if (sub != self.subset_select.default_text and
+ not isinstance(dict_subset_to_state[sub], CompositeSubsetState)):
+ self.is_centerable = True
+ _do_recentering(sub, dict_subset_to_state[sub])
+ elif (sub != self.subset_select.default_text and
+ isinstance(dict_subset_to_state[sub], CompositeSubsetState)):
+ self.hub.broadcast(SnackbarMessage(f"Unable to recenter "
+ f"composite subset {sub}",
+ color='error', sender=self))
+
+ def get_center(self, subset_name=None):
"""Return the center of the Subset.
This may or may not be the centroid obtain from data.
+ Parameters
+ ----------
+ subset_name : str
+ The name of the subset that is being updated.
+
Returns
-------
cen : number, tuple of numbers, or `None`
@@ -409,10 +467,17 @@ def get_center(self):
if not self.is_centerable: # no-op
return
- subset_state = self.subset_select.selected_subset_state
+ if self.multiselect and not subset_name:
+ raise ValueError("Please include subset_name in"
+ " get_center call when in multiselect mode")
+ elif not self.multiselect:
+ subset_state = self.subset_select.selected_subset_state
+ elif self.multiselect and subset_name:
+ subset_state = self.subset_select.selected_subset_state[subset_name]
+
return subset_state.center()
- def set_center(self, new_cen, update=False):
+ def set_center(self, new_cen, subset_name=None, update=False):
"""Set the desired center for the selected Subset, if applicable.
If Subset is not centerable, nothing is done.
@@ -421,7 +486,8 @@ def set_center(self, new_cen, update=False):
new_cen : number or tuple of numbers
The new center defined either as ``x`` or ``(x, y)``,
depending on the Subset type.
-
+ subset_name : str
+ The name of the subset that is being updated.
update : bool
If `True`, the Subset is also moved to the new center.
Otherwise, only the relevant editable fields are updated but the
@@ -437,36 +503,35 @@ def set_center(self, new_cen, update=False):
if not self.is_centerable: # no-op
return
- subset_state = self.subset_select.selected_subset_state
-
+ if self.multiselect and not subset_name:
+ raise ValueError("Please include subset_name in"
+ " set_center call when in multiselect mode")
+ elif not self.multiselect:
+ subset_state = self.subset_select.selected_subset_state
+ elif self.multiselect and subset_name:
+ subset_state = self.subset_select.selected_subset_state[subset_name]
if isinstance(subset_state, RoiSubsetState):
x, y = new_cen
+ # x and y are arrays so this converts them back to floats
+ x = float(x)
+ y = float(y)
sbst_obj = subset_state.roi
if isinstance(sbst_obj, (CircularROI, CircularAnnulusROI, EllipticalROI)):
- self._set_value_in_subset_definition(0, "X Center", "value", x)
- self._set_value_in_subset_definition(0, "Y Center", "value", y)
+ sbst_obj.move_to(x, y)
elif isinstance(sbst_obj, RectangularROI):
- cx, cy = sbst_obj.center()
- dx = x - cx
- dy = y - cy
- self._set_value_in_subset_definition(0, "Xmin", "value", sbst_obj.xmin + dx)
- self._set_value_in_subset_definition(0, "Xmax", "value", sbst_obj.xmax + dx)
- self._set_value_in_subset_definition(0, "Ymin", "value", sbst_obj.ymin + dy)
- self._set_value_in_subset_definition(0, "Ymax", "value", sbst_obj.ymax + dy)
+ sbst_obj.move_to(x, y)
else: # pragma: no cover
raise NotImplementedError(f'Recentering of {sbst_obj.__class__} is not supported')
elif isinstance(subset_state, RangeSubsetState):
- dx = new_cen - subset_state.center()
- self._set_value_in_subset_definition(0, "Lower bound", "value", subset_state.lo + dx)
- self._set_value_in_subset_definition(0, "Upper bound", "value", subset_state.hi + dx)
+ subset_state.move_to(new_cen)
else: # pragma: no cover
raise NotImplementedError(
f'Getting center of {subset_state.__class__} is not supported')
if update:
- self.vue_update_subset()
+ self._push_update_to_ui(subset_name=subset_name)
else:
# Force UI to update on browser without changing the subset.
tmp = self.subset_definitions
diff --git a/jdaviz/configs/default/plugins/subset_plugin/subset_plugin.vue b/jdaviz/configs/default/plugins/subset_plugin/subset_plugin.vue
index 10de628e01..14060d4135 100644
--- a/jdaviz/configs/default/plugins/subset_plugin/subset_plugin.vue
+++ b/jdaviz/configs/default/plugins/subset_plugin/subset_plugin.vue
@@ -4,11 +4,28 @@
:link="docs_link || 'https://jdaviz.readthedocs.io/en/'+vdocs+'/'+config+'/plugins.html#subset-tools'"
:popout_button="popout_button">
+
+
+
+
+
+
+ ![]()
+
+
+
-
+
Simplify
diff --git a/jdaviz/configs/imviz/tests/test_subset_centroid.py b/jdaviz/configs/imviz/tests/test_subset_centroid.py
index 4505434e21..16accd56b9 100644
--- a/jdaviz/configs/imviz/tests/test_subset_centroid.py
+++ b/jdaviz/configs/imviz/tests/test_subset_centroid.py
@@ -56,9 +56,10 @@ def test_centroiding(self):
assert plg._obj._get_value_from_subset_definition(0, key, "value") == -1
assert plg._obj._get_value_from_subset_definition(0, key, "orig") == -1
- # This ends up not getting used in production but just in case we need it
- # back in the future.
+ # The functionality for set_center has changed so that the subset state itself
+ # is updated but that change is not propagated to subset_definitions or the UI until
+ # vue_update_subset is called.
plg._obj.set_center((2, 2), update=False)
for key in ("X Center", "Y Center"):
- assert plg._obj._get_value_from_subset_definition(0, key, "value") == 2
+ assert plg._obj._get_value_from_subset_definition(0, key, "value") == -1
assert plg._obj._get_value_from_subset_definition(0, key, "orig") == -1
diff --git a/jdaviz/configs/specviz/plugins/line_analysis/tests/test_line_analysis.py b/jdaviz/configs/specviz/plugins/line_analysis/tests/test_line_analysis.py
index d28f6e6fc6..5008c958ab 100644
--- a/jdaviz/configs/specviz/plugins/line_analysis/tests/test_line_analysis.py
+++ b/jdaviz/configs/specviz/plugins/line_analysis/tests/test_line_analysis.py
@@ -88,8 +88,8 @@ def test_user_api(specviz_helper, spectrum1d):
la = specviz_helper.plugins['Line Analysis']
la.keep_active = True
- # spectral subset does not support multiselect
- assert "multiselect" not in la.spectral_subset.__repr__()
+ # spectral subset now supports multiselect
+ assert "multiselect" in la.spectral_subset.__repr__()
with pytest.raises(ValueError):
la.spectral_subset.select_all()
with pytest.raises(ValueError):
diff --git a/jdaviz/core/template_mixin.py b/jdaviz/core/template_mixin.py
index c221fe4489..8fa56e85f2 100644
--- a/jdaviz/core/template_mixin.py
+++ b/jdaviz/core/template_mixin.py
@@ -1383,7 +1383,7 @@ class SubsetSelect(SelectPluginComponent):
/>
"""
- def __init__(self, plugin, items, selected, selected_has_subregions=None,
+ def __init__(self, plugin, items, selected, multiselect=None, selected_has_subregions=None,
viewers=None, default_text=None, manual_options=[], filters=[],
default_mode='default_text'):
"""
@@ -1413,6 +1413,7 @@ def __init__(self, plugin, items, selected, selected_has_subregions=None,
super().__init__(plugin,
items=items,
selected=selected,
+ multiselect=multiselect,
filters=filters,
selected_has_subregions=selected_has_subregions,
viewers=viewers,
@@ -1490,14 +1491,18 @@ def _update_subset(self, subset, attribute=None):
else self._subset_to_dict(subset)
for s in self.items]
- if attribute == 'subset_state' and subset.label == self.selected:
+ if (attribute == 'subset_state' and
+ ((self.is_multiselect and subset.label in self.selected)
+ or (subset.label == self.selected))):
# updated the currently selected subset
self._clear_cache("selected_obj", "selected_item")
self._update_has_subregions()
def _update_has_subregions(self):
if "selected_has_subregions" in self._plugin_traitlets.keys():
- if (
+ if self.is_multiselect:
+ self.selected_has_subregions = False
+ elif (
self.selected in self._manual_options or
not hasattr(self.selected_obj, 'subregions')
):
@@ -1517,12 +1522,24 @@ def selected_obj(self):
@property
def selected_subset_state(self):
+ if self.is_multiselect:
+ subset_states = {}
+ for select_subset in self.selected:
+ if select_subset == self.default_text:
+ continue
+ subset_group = [s for s in self.app.data_collection.subset_groups if
+ s.label == select_subset][0]
+ subset_states[select_subset] = subset_group.subset_state
+ return subset_states
subset_group = [s for s in self.app.data_collection.subset_groups if
s.label == self.selected][0]
return subset_group.subset_state
@property
def selected_subset_mask(self):
+ if self.is_multiselect:
+ raise NotImplementedError("Retrieving subset mask is not"
+ " supported in multiselect mode")
get_data_kwargs = {'data_label': self.plugin.dataset.selected}
if 'is_spectral' in self.filters:
get_data_kwargs['spectral_subset'] = self.selected
@@ -1540,6 +1557,9 @@ def selected_subset_mask(self):
return subset.mask
def selected_min_max(self, spectrum1d):
+ if self.is_multiselect:
+ raise TypeError("This action cannot be done when multiselect is active")
+
if self.selected_obj is None:
return np.nanmin(spectrum1d.spectral_axis), np.nanmax(spectrum1d.spectral_axis)
if self.selected_item.get('type') != 'spectral':
diff --git a/jdaviz/tests/test_subsets.py b/jdaviz/tests/test_subsets.py
index 030edfd57e..c1be5ae69a 100644
--- a/jdaviz/tests/test_subsets.py
+++ b/jdaviz/tests/test_subsets.py
@@ -539,6 +539,25 @@ def test_recenter_linked_by_wcs(imviz_helper):
# But if not, it move down by 7 pix or so (229.05, 145.92) and fails the test.
assert_allclose(subset_plugin.get_center(), (229.067822, 152.371943))
+ # Now create a new subset that has a source in the corner and test
+ # recentering with multiselect.
+
+ imviz_helper.load_regions(
+ CirclePixelRegion(center=PixCoord(x=145, y=175), radius=17))
+ subset_plugin.multiselect = True
+ subset_plugin.subset_selected = ["Subset 1", "Subset 2"]
+
+ # Do it a few times to converge.
+ for _ in range(5):
+ subset_plugin.vue_recenter_subset()
+
+ assert_allclose(subset_plugin.get_center("Subset 2"), (145.593022, 172.515541))
+
+ with pytest.raises(ValueError, match="Please include subset_name in"):
+ subset_plugin.get_center()
+ with pytest.raises(ValueError, match="Please include subset_name in"):
+ subset_plugin.set_center((150, 200))
+
def test_with_invalid_subset_name(cubeviz_helper):
subset_name = "Test"