Capitalize parameter descriptions in draw package

This commit is contained in:
Johannes Schönberger
2012-08-26 00:32:20 +02:00
parent e9b8645ee6
commit 83a52f4d39
+10 -7
View File
@@ -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``.
"""