From 83a52f4d393ac1ffc3f951ad88e850c300e01ffc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Sun, 26 Aug 2012 00:32:20 +0200 Subject: [PATCH] Capitalize parameter descriptions in draw package --- skimage/draw/_draw.pyx | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/skimage/draw/_draw.pyx b/skimage/draw/_draw.pyx index fbd525fa..ca0c502a 100644 --- a/skimage/draw/_draw.pyx +++ b/skimage/draw/_draw.pyx @@ -65,6 +65,7 @@ def line(int y, int x, int y2, int x2): return rr, cc + @cython.boundscheck(False) @cython.wraparound(False) @cython.nonecheck(False) @@ -74,9 +75,9 @@ def polygon(y, x, shape=None): Parameters ---------- y : (N,) ndarray - y coordinates of vertices of polygon + Y-coordinates of vertices of polygon. x : (N,) ndarray - x coordinates of vertices of polygon + X-coordinates of vertices of polygon. shape : tuple, optional image shape which is used to determine maximum extents of output pixel coordinates. This is useful for polygons which exceed the image size. @@ -121,6 +122,7 @@ def polygon(y, x, shape=None): return np.array(rr), np.array(cc) + @cython.boundscheck(False) @cython.wraparound(False) @cython.nonecheck(False) @@ -131,9 +133,9 @@ def ellipse(double cy, double cx, double b, double a, shape=None): Parameters ---------- cy, cx : double - centre coordinate of ellipse + Centre coordinate of ellipse. b, a: double - minor and major semi-axes. (x/a)**2 + (y/b)**2 = 1 + Minor and major semi-axes. ``(x/a)**2 + (y/b)**2 = 1``. Returns ------- @@ -166,20 +168,21 @@ def ellipse(double cy, double cx, double b, double a, shape=None): return np.array(rr), np.array(cc) + def circle(double cy, double cx, double radius, shape=None): """Generate coordinates of pixels within circle. Parameters ---------- cy, cx : double - centre coordinate of circle + Centre coordinate of circle. radius: double - radius of circle + Radius of circle. Returns ------- rr, cc : ndarray of int - Pixel coordinates of ellipse. + Pixel coordinates of circle. May be used to directly index into an array, e.g. ``img[rr, cc] = 1``. """