diff --git a/CHANGES.rst b/CHANGES.rst index 1fa43b38..58c76796 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -59,6 +59,9 @@ New Features - Added the DS9 'boxcircle' point symbol. [#387] +- Enable rotation of the ``as_mpl_selector`` widgets for rectangular + and ellipse regions with matplotlib versions supporting this. [#390] + - Added the ability to add and subtract ``PixCoord`` objects. [#396] - Added an ``origin`` keyword to ``PolygonPixelRegion`` to allow diff --git a/regions/_utils/optional_deps.py b/regions/_utils/optional_deps.py index 22438364..21d5279e 100644 --- a/regions/_utils/optional_deps.py +++ b/regions/_utils/optional_deps.py @@ -3,11 +3,12 @@ try: import matplotlib HAS_MATPLOTLIB = True - MPL_VERSION = getattr(matplotlib, '__version__', None) - if MPL_VERSION is None: - MPL_VERSION = matplotlib._version.version - MPL_VERSION = MPL_VERSION.split('.') + MPL_VER_STR = getattr(matplotlib, '__version__', None) + if MPL_VER_STR is None: + MPL_VER_STR = matplotlib._version.version + MPL_VERSION = MPL_VER_STR.split('.') MPL_VERSION = 10 * int(MPL_VERSION[0]) + int(MPL_VERSION[1]) except ImportError: HAS_MATPLOTLIB = False + MPL_VER_STR = 'None' MPL_VERSION = 0 diff --git a/regions/shapes/ellipse.py b/regions/shapes/ellipse.py index 37860fa6..67e71c50 100644 --- a/regions/shapes/ellipse.py +++ b/regions/shapes/ellipse.py @@ -212,13 +212,23 @@ def as_artist(self, origin=(0, 0), **kwargs): **mpl_kwargs) def _update_from_mpl_selector(self, *args, **kwargs): + # _rect_properties replace _rect_bbox in matplotlib#19864, unchanged in #20839. + # "Note that if rotation != 0, ``xmin, ymin`` are always interpreted as the + # lower corner, and ``xmax, ymax`` are calculated using only width and + # height assuming no rotation (as specified for ``selector.extents``)." + xmin, xmax, ymin, ymax = self._mpl_selector.extents - self.center = PixCoord(x=0.5 * (xmin + xmax), - y=0.5 * (ymin + ymax)) - self.width = (xmax - xmin) - self.height = (ymax - ymin) - self.angle = 0. * u.deg - if self._mpl_selector_callback is not None: + self.width = xmax - xmin + self.height = ymax - ymin + if hasattr(self._mpl_selector, 'rotation'): + rotation = self._mpl_selector.rotation + self.center = PixCoord(*self._mpl_selector.center) + else: + self.center = PixCoord(x=0.5 * (xmin + xmax), y=0.5 * (ymin + ymax)) + rotation = 0 + self.angle = rotation * u.deg + + if getattr(self, '_mpl_selector_callback', None) is not None: self._mpl_selector_callback(self) def as_mpl_selector(self, ax, active=True, sync=True, callback=None, @@ -264,14 +274,14 @@ def as_mpl_selector(self, ax, active=True, sync=True, callback=None, ``selector.set_active(True)`` or ``selector.set_active(False)``. """ from matplotlib.widgets import EllipseSelector - - from regions._utils.optional_deps import MPL_VERSION + from regions._utils.optional_deps import MPL_VERSION, MPL_VER_STR if hasattr(self, '_mpl_selector'): raise AttributeError('Cannot attach more than one selector to a region.') - if self.angle.value != 0: - raise NotImplementedError('Cannot create matplotlib selector for rotated ellipse.') + if self.angle.value != 0 and not hasattr(EllipseSelector, 'rotation'): + raise NotImplementedError('Creating selectors for rotated shapes is not ' + f'yet supported with matplotlib {MPL_VER_STR}.') if sync: sync_callback = self._update_from_mpl_selector @@ -292,10 +302,13 @@ def sync_callback(*args, **kwargs): self._mpl_selector = EllipseSelector(ax, sync_callback, interactive=True, **kwargs) - self._mpl_selector.extents = (self.center.x - self.width / 2, - self.center.x + self.width / 2, - self.center.y - self.height / 2, - self.center.y + self.height / 2) + xy0 = [self.center.x - self.width / 2, self.center.y - self.height / 2] + self._mpl_selector.extents = (xy0[0], self.center.x + self.width / 2, + xy0[1], self.center.y + self.height / 2) + + if self.angle.value != 0: + self._mpl_selector.rotation = self.angle.to_value('deg') + self._mpl_selector.set_active(active) self._mpl_selector_callback = callback diff --git a/regions/shapes/rectangle.py b/regions/shapes/rectangle.py index 2803aed7..aaca0f6e 100644 --- a/regions/shapes/rectangle.py +++ b/regions/shapes/rectangle.py @@ -208,13 +208,23 @@ def as_artist(self, origin=(0, 0), **kwargs): angle=angle, **mpl_kwargs) def _update_from_mpl_selector(self, *args, **kwargs): + # _rect_properties replace _rect_bbox in matplotlib#19864, unchanged in #20839. + # "Note that if rotation != 0, ``xmin, ymin`` are always interpreted as the + # lower corner, and ``xmax, ymax`` are calculated using only width and + # height assuming no rotation (as specified for ``selector.extents``)." + xmin, xmax, ymin, ymax = self._mpl_selector.extents - self.center = PixCoord(x=0.5 * (xmin + xmax), - y=0.5 * (ymin + ymax)) - self.width = (xmax - xmin) - self.height = (ymax - ymin) - self.angle = 0. * u.deg - if self._mpl_selector_callback is not None: + self.width = xmax - xmin + self.height = ymax - ymin + if hasattr(self._mpl_selector, 'rotation'): + rotation = self._mpl_selector.rotation + self.center = PixCoord(*self._mpl_selector.center) + else: + self.center = PixCoord(x=0.5 * (xmin + xmax), y=0.5 * (ymin + ymax)) + rotation = 0 + self.angle = rotation * u.deg + + if getattr(self, '_mpl_selector_callback', None) is not None: self._mpl_selector_callback(self) def as_mpl_selector(self, ax, active=True, sync=True, callback=None, @@ -260,15 +270,14 @@ def as_mpl_selector(self, ax, active=True, sync=True, callback=None, ``selector.set_active(True)`` or ``selector.set_active(False)``. """ from matplotlib.widgets import RectangleSelector - - from regions._utils.optional_deps import MPL_VERSION + from regions._utils.optional_deps import MPL_VERSION, MPL_VER_STR if hasattr(self, '_mpl_selector'): raise AttributeError('Cannot attach more than one selector to a region.') - if self.angle.value != 0: - raise NotImplementedError('Cannot create matplotlib selector for ' - 'rotated rectangle.') + if self.angle.value != 0 and not hasattr(RectangleSelector, 'rotation'): + raise NotImplementedError('Creating selectors for rotated shapes is not ' + f'yet supported with matplotlib {MPL_VER_STR}.') if sync: sync_callback = self._update_from_mpl_selector @@ -289,10 +298,13 @@ def sync_callback(*args, **kwargs): self._mpl_selector = RectangleSelector(ax, sync_callback, interactive=True, **kwargs) - self._mpl_selector.extents = (self.center.x - self.width / 2, - self.center.x + self.width / 2, - self.center.y - self.height / 2, - self.center.y + self.height / 2) + dxy = [self.width / 2, self.height / 2] + self._mpl_selector.extents = (self.center.x - dxy[0], self.center.x + dxy[0], + self.center.y - dxy[1], self.center.y + dxy[1]) + + if self.angle.value != 0: + self._mpl_selector.rotation = self.angle.to_value('deg') + self._mpl_selector.set_active(active) self._mpl_selector_callback = callback diff --git a/regions/shapes/tests/test_ellipse.py b/regions/shapes/tests/test_ellipse.py index dd368f44..8133b6e2 100644 --- a/regions/shapes/tests/test_ellipse.py +++ b/regions/shapes/tests/test_ellipse.py @@ -129,12 +129,20 @@ def update_mask(reg): # For now this will only work with unrotated ellipses. Once this # works with rotated ellipses, the following exception check can # be removed as well as the ``angle=0 * u.deg`` in the call to - # copy() below. - with pytest.raises(NotImplementedError, - match=('Cannot create matplotlib selector for rotated ellipse.')): - self.reg.as_mpl_selector(ax) + # copy() below - should (hopefully) be implemented with mpl 3.6. + expected = [8.3, 4.9, 2.0, 1.0] + if MPL_VERSION < 36: + with pytest.raises(NotImplementedError, + match='Creating selectors for rotated shapes is not yet supported'): + self.reg.as_mpl_selector(ax) + angle = 0 * u.deg + else: + angle = self.reg.angle - region = self.reg.copy(angle=0 * u.deg) + if not sync: + expected = [3, 4, 4, 3] + + region = self.reg.copy(angle=angle) selector = region.as_mpl_selector(ax, callback=update_mask, sync=sync) @@ -144,24 +152,16 @@ def update_mask(reg): ax.figure.canvas.draw() - if sync: + assert_allclose(region.center.x, expected[0]) + assert_allclose(region.center.y, expected[1]) + assert_allclose(region.width, expected[2]) + assert_allclose(region.height, expected[3]) - assert_allclose(region.center.x, 8.3) - assert_allclose(region.center.y, 4.9) - assert_allclose(region.width, 2) - assert_allclose(region.height, 1) + if sync: assert_quantity_allclose(region.angle, 0 * u.deg) - assert_equal(mask, region.to_mask(mode='subpixels', subpixels=10).to_image(data.shape)) - else: - - assert_allclose(region.center.x, 3) - assert_allclose(region.center.y, 4) - assert_allclose(region.width, 4) - assert_allclose(region.height, 3) - assert_quantity_allclose(region.angle, 0 * u.deg) - + assert_quantity_allclose(region.angle, angle) assert_equal(mask, 0) with pytest.raises(AttributeError, match=('Cannot attach more than one selector to a reg')): diff --git a/regions/shapes/tests/test_rectangle.py b/regions/shapes/tests/test_rectangle.py index ca7d8185..e7b6c3ab 100644 --- a/regions/shapes/tests/test_rectangle.py +++ b/regions/shapes/tests/test_rectangle.py @@ -135,12 +135,21 @@ def update_mask(reg): # For now this will only work with unrotated rectangles. Once # this works with rotated rectangles, the following exception # check can be removed as well as the ``angle=0 * u.deg`` in the - # call to copy() below. - with pytest.raises(NotImplementedError, - match=('Cannot create matplotlib selector for rotated rectangle.')): - self.reg.as_mpl_selector(ax) + # copy() below - should (hopefully) be implemented with mpl 3.6. + expected = [8.3, 4.9, 2.0, 1.0] + if MPL_VERSION < 36: + with pytest.raises(NotImplementedError, + match='Creating selectors for rotated shapes is not yet supported'): + self.reg.as_mpl_selector(ax) + + angle = 0 * u.deg + else: + angle = self.reg.angle - region = self.reg.copy(angle=0 * u.deg) + if not sync: + expected = [3, 4, 4, 3] + + region = self.reg.copy(angle=angle) selector = region.as_mpl_selector(ax, callback=update_mask, sync=sync) @@ -150,22 +159,16 @@ def update_mask(reg): ax.figure.canvas.draw() + assert_allclose(region.center.x, expected[0]) + assert_allclose(region.center.y, expected[1]) + assert_allclose(region.width, expected[2]) + assert_allclose(region.height, expected[3]) + if sync: - assert_allclose(region.center.x, 8.3) - assert_allclose(region.center.y, 4.9) - assert_allclose(region.width, 2) - assert_allclose(region.height, 1) assert_quantity_allclose(region.angle, 0 * u.deg) - assert_equal(mask, region.to_mask(mode='subpixels', subpixels=10).to_image(data.shape)) - else: - assert_allclose(region.center.x, 3) - assert_allclose(region.center.y, 4) - assert_allclose(region.width, 4) - assert_allclose(region.height, 3) - assert_quantity_allclose(region.angle, 0 * u.deg) - + assert_quantity_allclose(region.angle, angle) assert_equal(mask, 0) with pytest.raises(AttributeError, match=('Cannot attach more than one selector to a reg')):