Rectangle Selector Upgrade #3937

blink1073 · 2014-12-20T03:27:34Z

This builds on #3486 and #3502.

This improves the RectangleSelector and adds an EllipseSelector with minimal code differences.
Improvements:

Visible handles for manipulating the shape after it has been drawn
Keyboard modifiers:
Alt or Space moves the existing shape (as does dragging the center handle)
Shift makes the shape square (or circular)
Ctrl makes the initial point the center of the shape (helpful for ellipses)
Ctrl and shift can be combined

The API is the same (unless using the modifier keys), but we add the interactive keyword arg to enable the new behavior.

tacaswell · 2014-12-23T17:36:27Z

lib/matplotlib/widgets.py

-            self.eventpress.xdata, self.eventpress.ydata = (
-                self._get_data(event))
-            return True
-        return False


This should maintain the return behaviour.

tacaswell · 2014-12-23T23:30:01Z

The test failures look like they are coming out of bar3D tests which I suspect are unrelated.

blink1073 · 2014-12-24T03:29:16Z

@tacaswell I believe I addressed your concern about return values.

tacaswell · 2014-12-24T03:34:18Z

lib/matplotlib/tests/test_widgets.py

@@ -99,11 +110,98 @@ def test_rectangle_selector():
    check_rectangle(rectprops=dict(fill=True))


+def test_ellipse():


These need @cleanup decorators, I suspect that is related to the seemingly un-related failures as the global state of pyplot leaks across tests.

tacaswell · 2014-12-24T07:41:21Z

Down to pep8 issues:

======================================================================

FAIL: matplotlib.tests.test_coding_standards.test_pep8_conformance_installed_files

----------------------------------------------------------------------

Traceback (most recent call last):

File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/nose/case.py", line 197, in runTest

self.test(*self.arg)

File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/matplotlib-1.5.dev1-py2.7-linux-x86_64.egg/matplotlib/tests/test_coding_standards.py", line 255, in test_pep8_conformance_installed_files

expected_bad_files=expected_bad_files)

File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/matplotlib-1.5.dev1-py2.7-linux-x86_64.egg/matplotlib/tests/test_coding_standards.py", line 140, in assert_pep8_conformance

assert_equal(result.total_errors, 0, msg)

AssertionError: Found code syntax errors (and warnings):

/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/matplotlib-1.5.dev1-py2.7-linux-x86_64.egg/matplotlib/tests/test_widgets.py:190:27: E222 multiple spaces after operator

/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/matplotlib-1.5.dev1-py2.7-linux-x86_64.egg/matplotlib/tests/test_widgets.py:196:27: E222 multiple spaces after operator

----------------------------------------------------------------------

tacaswell · 2015-01-31T18:28:18Z

This fell off the bottom of my internal FILO buffer, what is the state of this?

blink1073 · 2015-01-31T18:34:25Z

The last few commits were some cleanup as a result of using this branch to make the contrast selector tool. I'd say its done and ready.

tacaswell · 2015-01-31T18:37:53Z

Current priority is getting 1.4.3rc1 cut, hopefully I will be able to loop back to the master branch stuff 'soon'.

blink1073 · 2015-01-31T19:51:07Z

No problemo.

fariza · 2015-08-05T23:10:28Z

@blink1073 it's been a long time, but did you test this changes with the new toolmanager introduced in MEP22?
I foresee some problems with the key_press_event that ToolManager also uses to trigger tools

blink1073 · 2015-08-07T14:15:02Z

@fariza, I just did a rebase and played with the RectangleSelect widget, it is working as intended.

fariza · 2015-08-07T14:41:11Z

My concern comes from #1368
At the same time, ToolManager adds a keypresslock to redirect keypress events, and these widgets use the event to mvoe around the selection.
I was thinking in moving the keypresslock to the canvas, and have everybody using it widgets and toolmanager so there are no tools triggered unintentionally

blink1073 · 2015-08-07T14:43:19Z

That makes sense to me.

fariza · 2015-08-07T17:42:16Z

I just tried and I noticed a little change in the behaviour.
With this change the selection is not cleared after release, is this the correct thing to do?

fariza · 2015-08-07T17:48:30Z

Sorry, I just read the description.
Running the example rectangle_selector.py there are no handles to modify the shape, I think if we are going to modify the widget, we have to modify the example to reflect the changes accordingly.
And, if the selection is going to stay in place after using it, what would be the normal way to remove it?

blink1073 · 2015-08-07T18:23:52Z

@fariza, assuming @tacaswell agrees with the new behavior, I can update the example. One would clear the selection by clicking outside of the selection (without dragging).

fariza · 2015-08-07T18:43:56Z

Wouldn't it be better to add a kwarg to persist after release?
Given that you are capturing key_press_events what about adding the 'esc' key to remove the selection?
If I'm not wrong this widget is not using the ignore method to prevent collisions

blink1073 · 2015-08-08T19:50:27Z

I agree with both statements: preserve the previous behavior and allow the escape key to clear the selection.

blink1073 · 2015-08-25T09:13:02Z

Ah, I remember now. It is "control" if it is the only key and "ctrl" in a key combination. I can just account for that one special case.

blink1073 · 2015-08-25T12:32:13Z

How about a state_keys dictionary for a _Selection widget, where you can override the default states or provide new ones?

WeatherGod · 2015-08-25T15:01:14Z

Interesting idea. It would help keep the constructor from getting cluttered.

On Tue, Aug 25, 2015 at 8:32 AM, Steven Silvester [email protected]
wrote:

How about a state_keys dictionary for a _Selection widget, where you can
override the default states or provide new ones?

—
Reply to this email directly or view it on GitHub
#3937 (comment)
.

fariza · 2015-08-25T15:48:18Z

@blink1073 I like the interactive kwarg.
In the interactive mode, if I press Esc it dissapears but reapears after I click twice anywhere in the axes, is this the intended behavior?

@WeatherGod @tacaswell There are several places around the code, that we hardcoded keys to specific functions.
We have to get a standardized way of doing this. In the case of toolmanager the tools can capture key_press_event and do stuff inside, but so far there is no way of modifying this.
I kind of like the idea of a kwarg with a dictionary. But I would be careful with the naming, this has to be easily transportable to all the widgets and tools, state_keys is not easily identifiable.
I guess we need a keys_compat.py somewhere to deal with different keys in different backends, and force widget and tools creators to use that when they specify default keys.

…hape

blink1073 · 2015-08-26T13:20:48Z

I settled on state_modifier_keys, how does that sound?
Also, I fixed the double-click zombie shape behavior.

tacaswell · 2015-08-28T17:52:57Z

Both test failures looked like the tex related transients.

@fariza I agree re the need for a centralized way to manage key event bindings, but want to punt on that for this PR.

@WeatherGod If you are happy, please merge this.

WeatherGod · 2015-09-01T03:16:53Z

lib/matplotlib/widgets.py

        self.connect_default_events()

+        self.state_modifier_keys = dict(move=' ', clear='escape',
+                                        square='shift', center='ctrl')


I like this. It also helps to keep all the possible actions and associated keys in one place.

ENH: Rectangle Selector Upgrade

tacaswell · 2015-09-08T00:49:58Z

@blink1073 Can you add a whats_new in a new PR?

tacaswell · 2015-09-08T00:50:29Z

@WeatherGod Merged this as no activity for a week, we can iterate in smaller PRs if needed.

WeatherGod · 2015-09-08T13:31:17Z

@tacaswell, indeed. Sorry for the silence on my end as other things came up. Unfortunately, I don't see much relief in sight over the next few weeks.

blink1073 · 2015-09-08T13:33:25Z

@tacaswell, which one would you like next? I was thinking LassoSelector.

tacaswell · 2015-09-09T00:03:43Z

LassoSelector sounds good to me.

On Tue, Sep 8, 2015 at 9:33 AM Steven Silvester [email protected]
wrote:

@tacaswell https://github.com/tacaswell, which one would you like next?
I was thinking LassoSelector.

—
Reply to this email directly or view it on GitHub
#3937 (comment)
.

Shekhrozx · 2018-10-06T07:26:02Z

This builds on #3486 and #3502.

This improves the RectangleSelector and adds an EllipseSelector with minimal code differences.
Improvements:

Visible handles for manipulating the shape after it has been drawn

Keyboard modifiers:

Alt or Space moves the existing shape (as does dragging the center handle)

Shift makes the shape square (or circular)

Ctrl makes the initial point the center of the shape (helpful for ellipses)

Ctrl and shift can be combined

The API is the same (unless using the modifier keys), but we add the interactive keyword arg to enable the new behavior.

How to remove Rectangle Selector from the figure? Is it possible?

tacaswell added the status: needs review label Dec 20, 2014

tacaswell reviewed Dec 23, 2014
View reviewed changes

tacaswell reviewed Dec 24, 2014
View reviewed changes

JDWarner mentioned this pull request Jan 2, 2015

Replace Viewer Framework with IPython Widgets scikit-image/scikit-image#1311

Closed

tacaswell added this to the v1.5.x milestone Jan 31, 2015

tacaswell added the topic: widgets/UI label Jan 31, 2015

tacaswell modified the milestones: proposed next point release, next point release Feb 19, 2015

tacaswell added the Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. label Jun 18, 2015

blink1073 force-pushed the rectangle_selector_upgrade branch from 7a30732 to f73682f Compare August 7, 2015 14:15

blink1073 added 3 commits August 26, 2015 08:12

Use new state_modifier_keys dictionary

8e8e473

Clear the active handle when invisible

2ed0419

Collapse the shape on improper draw to prevent showing the previous s…

d5b5d86

…hape

Fix test using 'alt' key

87ab199

WeatherGod reviewed Sep 1, 2015
View reviewed changes

blink1073 added 2 commits September 1, 2015 08:07

Clean up and add more docs

9eaae32

Make on_key_release use the state_modifier_keys

819804f

tacaswell mentioned this pull request Sep 2, 2015

outstanding issues from jpl #4897

Closed

17 tasks

tacaswell added a commit that referenced this pull request Sep 8, 2015

Merge pull request #3937 from blink1073/rectangle_selector_upgrade

8150af7

ENH: Rectangle Selector Upgrade

tacaswell merged commit 8150af7 into matplotlib:master Sep 8, 2015

tacaswell removed the status: needs review label Sep 8, 2015

blink1073 mentioned this pull request Sep 8, 2015

Update what's new for RectangeSelector #5036

Merged

tacaswell mentioned this pull request Oct 30, 2017

Widgets: RectangleSelector in Mpl 2.1.0 does not behave as described #9608

Closed

		@@ -99,11 +110,98 @@ def test_rectangle_selector():
		check_rectangle(rectprops=dict(fill=True))


		def test_ellipse():

Uh oh!

Rectangle Selector Upgrade #3937

Rectangle Selector Upgrade #3937

Uh oh!

Conversation

blink1073 commented Dec 20, 2014

Uh oh!

tacaswell Dec 23, 2014

Choose a reason for hiding this comment

Uh oh!

tacaswell commented Dec 23, 2014

Uh oh!

blink1073 commented Dec 24, 2014

Uh oh!

tacaswell Dec 24, 2014

Choose a reason for hiding this comment

Uh oh!

tacaswell commented Dec 24, 2014

Uh oh!

tacaswell commented Jan 31, 2015

Uh oh!

blink1073 commented Jan 31, 2015

Uh oh!

tacaswell commented Jan 31, 2015

Uh oh!

blink1073 commented Jan 31, 2015

Uh oh!

fariza commented Aug 5, 2015

Uh oh!

blink1073 commented Aug 7, 2015

Uh oh!

fariza commented Aug 7, 2015

Uh oh!

blink1073 commented Aug 7, 2015

Uh oh!

fariza commented Aug 7, 2015

Uh oh!

fariza commented Aug 7, 2015

Uh oh!

blink1073 commented Aug 7, 2015

Uh oh!

fariza commented Aug 7, 2015

Uh oh!

blink1073 commented Aug 8, 2015

Uh oh!

blink1073 commented Aug 25, 2015

Uh oh!

blink1073 commented Aug 25, 2015

Uh oh!

WeatherGod commented Aug 25, 2015

Uh oh!

fariza commented Aug 25, 2015

Uh oh!

blink1073 commented Aug 26, 2015

Uh oh!

tacaswell commented Aug 28, 2015

Uh oh!

WeatherGod Sep 1, 2015

Choose a reason for hiding this comment

Uh oh!

tacaswell commented Sep 8, 2015

Uh oh!

tacaswell commented Sep 8, 2015

Uh oh!

WeatherGod commented Sep 8, 2015

Uh oh!

blink1073 commented Sep 8, 2015

Uh oh!

tacaswell commented Sep 9, 2015

Uh oh!

Shekhrozx commented Oct 6, 2018

Uh oh!

Uh oh!