wassname/scikit-image
1
0
Fork 0
mirror of https://github.com/wassname/scikit-image.git synced 2026-07-05 08:31:31 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docstring circle + ellipse

Browse Source
This commit is contained in:
François Boulogne
2013-02-24 16:42:37 +01:00
parent 729b311efb
commit 19e69e94c1
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skimage/draw/_draw.pyx
+11 -1
View File
@@ -138,6 +138,10 @@ def ellipse(double cy, double cx, double yradius, double xradius, shape=None):
Centre coordinate of ellipse.
yradius, xradius : double
Minor and major semi-axes. ``(x/xradius)**2 + (y/yradius)**2 = 1``.
shape : tuple, optional
image shape which is used to determine maximum extents of output pixel
coordinates. This is useful for ellipses which exceed the image size.
By default the full extents of the ellipse are used.
Returns
-------
@@ -182,6 +186,10 @@ def circle(double cy, double cx, double radius, shape=None):
Centre coordinate of circle.
radius: double
Radius of circle.
shape : tuple, optional
image shape which is used to determine maximum extents of output pixel
coordinates. This is useful for circles which exceed the image size.
By default the full extents of the circle are used.
Returns
-------
@@ -189,7 +197,9 @@ def circle(double cy, double cx, double radius, shape=None):
Pixel coordinates of circle.
May be used to directly index into an array, e.g.
``img[rr, cc] = 1``.
Notes
-----
This function is a wrapper for skimage.draw.ellipse()
"""
return ellipse(cy, cx, radius, radius, shape)