linetool

LineTool

class skimage.viewer.canvastools.LineTool(manager, on_move=None, on_release=None, on_enter=None, maxdist=10, line_props=None, handle_props=None, **kwargs) [source]

Bases: skimage.viewer.canvastools.base.CanvasToolBase

Widget for line selection in a plot.

Parameters:

manager : Viewer or PlotPlugin. Skimage viewer or plot plugin object. on_move : function Function called whenever a control handle is moved. This function must accept the end points of line as the only argument. on_release : function Function called whenever the control handle is released. on_enter : function Function called whenever the “enter” key is pressed. maxdist : float Maximum pixel distance allowed when selecting control handle. line_props : dict Properties for matplotlib.lines.Line2D. handle_props : dict Marker properties for the handles (also see matplotlib.lines.Line2D).

Attributes

end_points

(2D array) End points of line ((x1, y1), (x2, y2)).

__init__(manager, on_move=None, on_release=None, on_enter=None, maxdist=10, line_props=None, handle_props=None, **kwargs) [source]

end_points

geometry

hit_test(event) [source]

on_mouse_press(event) [source]

on_mouse_release(event) [source]

on_move(event) [source]

update(x=None, y=None) [source]