Add option of bounding box for PolygonSelector #21830

dstansby · 2021-12-01T20:46:21Z

PR Summary

This allows one to put a bounding box around a PolygonSelector, that can be used for resizing and moving (and eventually rotating) the selector points.

import matplotlib.pyplot as plt
from matplotlib.widgets import PolygonSelector

fig, ax = plt.subplots()
sel = PolygonSelector(ax, lambda *args, **kwargs: None, draw_box=True)
plt.show()

polygon.mov

PR Checklist

Tests and Styling

Has pytest style unit tests (and pytest passes).
Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

New features are documented, with examples if plot related.
New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
Documentation is sphinx and numpydoc compliant (the docs should build without error).

dstansby · 2021-12-03T11:21:10Z

This should be ready for review now

ericpre

This works nicely, I made a couple of comments/suggestions.

lib/matplotlib/widgets.py

dhomeier

Thanks for the PR and updates; I have tested this with a method in astropy/regions#406 that uses this new functionality and see that some early quirks have already been resolved!
A general issue with that regions method, which connects a custom PolygonSelector, is that creating a complete instance is somewhat tedious – adding the vertices and then triggering a redraw and finally marking the selector _selection_completed; for most of this I have not found public methods for the required operations. Having those, analogously to extents etc. in RectangleSelector would be a plus (but not necessary from this PR).

lib/matplotlib/widgets.py

ericpre

This looks good, it just need the test to be fixed!

lib/matplotlib/tests/test_widgets.py

QuLogic

I wonder if it should be called draw_bbox, or even draw_bounding_box (since we seem to have pretty verbose names in widgets already.)

lib/matplotlib/tests/test_widgets.py

QuLogic · 2021-12-22T04:59:28Z

lib/matplotlib/tests/test_widgets.py

+    event_sequence = (polygon_place_vertex(*verts[0]) +
+                      polygon_place_vertex(*verts[1]) +
+                      polygon_place_vertex(*verts[2]) +
+                      polygon_place_vertex(*verts[3]) +
+                      polygon_place_vertex(*verts[0]))


Suggested change

event_sequence = (polygon_place_vertex(*verts[0]) +

polygon_place_vertex(*verts[1]) +

polygon_place_vertex(*verts[2]) +

polygon_place_vertex(*verts[3]) +

polygon_place_vertex(*verts[0]))

event_sequence = (

*polygon_place_vertex(*verts[0]),

*polygon_place_vertex(*verts[1]),

*polygon_place_vertex(*verts[2]),

*polygon_place_vertex(*verts[3]),

*polygon_place_vertex(*verts[0]),

)

I didn't do this since the rest of test_widgets.py uses the + notation. I'd be happy to put in a PR to change it all in one go though?

lib/matplotlib/widgets.py

doc/users/next_whats_new/polygon_selector_box.rst

lib/matplotlib/tests/test_widgets.py

lib/matplotlib/widgets.py

Update polygon every time bounding box is moved Allow box customisation Remove del Prevent rotation on polygon bounding box Fix line length Cleanup transform logic Don't use dicts as keyword defaults Minor doc fixes

Run exising polygon selector tests with draw_box=True

Trigger events on canvas in test Test doc fixes

dstansby · 2021-12-23T11:50:22Z

Thanks for reviewing. I changed the argument name to draw_bounding_box, but left the internal variables as _draw_box for simplicity. All other comments should be addressed. I also cleaned up the commit history a bit - sorry if this makes it a bit trickier to re-review...

doc/users/next_whats_new/polygon_selector_box.rst

Co-authored-by: Elliott Sales de Andrade <[email protected]>

examples/widgets/polygon_selector_demo.py

Co-authored-by: Elliott Sales de Andrade <[email protected]>

dstansby added the topic: widgets/UI label Dec 1, 2021

dstansby force-pushed the polygon-box branch 2 times, most recently from 5847eda to 4ac8e37 Compare December 3, 2021 11:06

dstansby added this to the v3.6.0 milestone Dec 3, 2021

ericpre reviewed Dec 5, 2021

View reviewed changes

lib/matplotlib/widgets.py Outdated Show resolved Hide resolved

lib/matplotlib/widgets.py Show resolved Hide resolved

lib/matplotlib/widgets.py Outdated Show resolved Hide resolved

lib/matplotlib/widgets.py Outdated Show resolved Hide resolved

dstansby force-pushed the polygon-box branch from 955354d to fbe3273 Compare December 5, 2021 17:56

dhomeier mentioned this pull request Dec 8, 2021

Add interactive matplotlib selector to PolygonPixelRegion astropy/regions#406

Draft

dhomeier suggested changes Dec 8, 2021

View reviewed changes

lib/matplotlib/widgets.py Show resolved Hide resolved

dstansby mentioned this pull request Dec 9, 2021

Jointly track x and y in PolygonSelector. #21894

Merged

6 tasks

dstansby force-pushed the polygon-box branch from 1095445 to 0f8d264 Compare December 9, 2021 21:38

dstansby marked this pull request as ready for review December 9, 2021 21:43

ericpre approved these changes Dec 11, 2021

View reviewed changes

lib/matplotlib/tests/test_widgets.py Outdated Show resolved Hide resolved

dstansby force-pushed the polygon-box branch from ca3c9c6 to a2d4414 Compare December 13, 2021 17:41

dstansby added the status: needs review label Dec 16, 2021

QuLogic reviewed Dec 22, 2021

View reviewed changes

dstansby added 4 commits December 23, 2021 11:48

Add option of bounding box for PolygonSelector

707844b

Update polygon every time bounding box is moved Allow box customisation Remove del Prevent rotation on polygon bounding box Fix line length Cleanup transform logic Don't use dicts as keyword defaults Minor doc fixes

Run exising polygon selector tests with draw_box=True

f228e2b

Run exising polygon selector tests with draw_box=True

Add tests for polygon selector box

a45ef42

Trigger events on canvas in test Test doc fixes

draw_box > draw_bounding_box

72e95f0

dstansby force-pushed the polygon-box branch from a2d4414 to 72e95f0 Compare December 23, 2021 11:49

QuLogic reviewed Dec 24, 2021

View reviewed changes

doc/users/next_whats_new/polygon_selector_box.rst Outdated Show resolved Hide resolved

Fix changelog argument name

60b28ab

Co-authored-by: Elliott Sales de Andrade <[email protected]>

QuLogic reviewed Dec 24, 2021

View reviewed changes

examples/widgets/polygon_selector_demo.py Outdated Show resolved Hide resolved

Fix example

ba7fdf2

Co-authored-by: Elliott Sales de Andrade <[email protected]>

QuLogic approved these changes Jan 5, 2022

View reviewed changes

QuLogic merged commit 37c9b04 into matplotlib:main Jan 5, 2022

QuLogic removed the status: needs review label Jan 5, 2022

dstansby deleted the polygon-box branch January 5, 2022 22:34

dstansby mentioned this pull request Jan 8, 2022

Polygon rotation #22159

Draft

6 tasks

Uh oh!

Add option of bounding box for PolygonSelector #21830

Add option of bounding box for PolygonSelector #21830

Uh oh!

Conversation

dstansby commented Dec 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

dstansby commented Dec 3, 2021

Uh oh!

ericpre left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dhomeier left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ericpre left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

QuLogic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

QuLogic Dec 22, 2021

Choose a reason for hiding this comment

Uh oh!

dstansby Dec 23, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dstansby commented Dec 23, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dstansby commented Dec 1, 2021 •

edited

Loading