From 70461b4bc968fdd2597a43c3d91e6b1559a920bd Mon Sep 17 00:00:00 2001 From: Tony S Yu Date: Thu, 13 Dec 2012 17:26:37 -0500 Subject: [PATCH] STY: Rename parameters for clarity --- skimage/viewer/canvastools/linetool.py | 13 +++++++++---- skimage/viewer/canvastools/recttool.py | 9 ++++----- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/skimage/viewer/canvastools/linetool.py b/skimage/viewer/canvastools/linetool.py index 91ca2bb2..1d672f0b 100644 --- a/skimage/viewer/canvastools/linetool.py +++ b/skimage/viewer/canvastools/linetool.py @@ -23,6 +23,11 @@ class LineTool(CanvasToolBase): 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 :class:`matplotlib.patches.Rectangle`. This class + redefines defaults in :class:`matplotlib.widgets.RectangleSelector`. Attributes ---------- @@ -30,12 +35,12 @@ class LineTool(CanvasToolBase): End points of line ((x1, y1), (x2, y2)). """ def __init__(self, ax, x, y, on_move=None, on_release=None, on_enter=None, - maxdist=10, lineprops=None): + maxdist=10, line_props=None): super(LineTool, self).__init__(ax, on_move=on_move, on_enter=on_enter, on_release=on_release) props = dict(color='r', linewidth=1, alpha=0.4, solid_capstyle='butt') - props.update(lineprops if lineprops is not None else {}) + props.update(line_props if line_props is not None else {}) self.linewidth = props['linewidth'] self.maxdist = maxdist self._active_pt = None @@ -102,13 +107,13 @@ class LineTool(CanvasToolBase): class ThickLineTool(LineTool): def __init__(self, ax, x, y, on_move=None, on_enter=None, on_release=None, - maxdist=10, lineprops=None): + maxdist=10, line_props=None): super(ThickLineTool, self).__init__(ax, x, y, on_move=on_move, on_enter=on_enter, on_release=on_release, maxdist=maxdist, - lineprops=lineprops) + line_props=line_props) self.connect_event('scroll_event', self.on_scroll) self.connect_event('key_press_event', self.on_key_press) diff --git a/skimage/viewer/canvastools/recttool.py b/skimage/viewer/canvastools/recttool.py index 8742124e..a8b74e87 100644 --- a/skimage/viewer/canvastools/recttool.py +++ b/skimage/viewer/canvastools/recttool.py @@ -27,9 +27,8 @@ class RectangleTool(mwidgets.RectangleSelector, CanvasToolBase): on_enter : function Function called whenever the "enter" key is pressed. maxdist : float - Maximum distance in pixels for selection of a control handle - (i.e. corner or edge) handle. - rectprops : dict + Maximum pixel distance allowed when selecting control handle. + rect_props : dict Properties for :class:`matplotlib.patches.Rectangle`. This class redefines defaults in :class:`matplotlib.widgets.RectangleSelector`. @@ -40,12 +39,12 @@ class RectangleTool(mwidgets.RectangleSelector, CanvasToolBase): """ def __init__(self, ax, on_move=None, on_release=None, on_enter=None, - maxdist=10, rectprops=None): + maxdist=10, rect_props=None): CanvasToolBase.__init__(self, ax, on_move=on_move, on_enter=on_enter, on_release=on_release) props = dict(edgecolor=None, facecolor='r', alpha=0.15) - props.update(rectprops if rectprops is not None else {}) + props.update(rect_props if rect_props is not None else {}) if props['edgecolor'] is None: props['edgecolor'] = props['facecolor'] mwidgets.RectangleSelector.__init__(self, ax, lambda *args: None,