mpl_qt_viz.roiSelection.LassoCreator

class mpl_qt_viz.roiSelection.LassoCreator(axMan, image, onselect=None)

Bases: mpl_qt_viz.roiSelection._creatorWidgets._base.CreatorWidgetBase

Allows the user to select a region with freehand drawing.

Parameters

• axMan (AxManager) – A reference to the AxManager object used to manage drawing the matplotlib Axes that this selector widget is active on.

• image (AxesImage) – A reference to a matplotlib AxesImage. Selectors may use this reference to get information such as data values from the image for computer vision related tasks.

• onselect – A callback function that will be called when the selector finishes a selection.

property active

Is the widget active?

addArtist(artist)

Add a matplotlib artist to be managed.

connect_event(event, callback)

Connect callback with an event.

This should be used in lieu of figure.canvas.mpl_connect since this function stores callback ids for later clean up.

disconnect_events()

Disconnect all events created by this widget.

static getHelpText()

Return a description of the selector which can be used as a tooltip.

get_active()

Get whether the widget is active.

ignore(event)

return True if event should be ignored. No event callbacks will be called if this returns true.

on_key_press(event)

Key press event handler and validator for all selection widgets

on_key_release(event)

Key release event handler and validator

on_scroll(event)

Mouse scroll event handler and validator

onmove(event)

Cursor move event handler and validator

onselect(verts, handles)

This method should be called when the interaction is done to execute whatever finalization function was specified in the constructor.

Parameters

• verts (PolygonCoords) – A sequence of 2-tuple coordinates that fully define the polygon.

• handles (PolygonCoords) – A reduced sequence of coordinates that define special points onthe shape to potentially be used as draggable handles for a modifier.

press(event)

Button press handler and validator

release(event)

Button release event handler and validator

removeArtists()

Remove all artist objects associated with this selector

reset()

Reset the state of the selector so it’s ready for a new selection.

setArtistVisible(artist, visible)

set visibility of a single artist, invisible artists will not be reenabled with set_visible True.

set_active(active)

Set whether the widget is active.

set_visible(visible)

Set the visibility of our artists