Update parameter list in docstring for consistency

This commit is contained in:
Juan Nunez-Iglesias
2014-06-12 01:20:53 +10:00
parent 8cba840a05
commit 34cf1f9243
+1 -5
View File
@@ -163,22 +163,18 @@ def medial_axis(image, mask=None, return_distance=False):
Parameters
----------
image : binary ndarray, shape (M, N)
The image of the shape to be skeletonized.
mask : binary ndarray, shape (M, N), optional
If a mask is given, only those elements in `image` with a true
value in `mask` are used for computing the medial axis.
return_distance : bool, optional
If true, the distance transform is returned as well as the skeleton.
Returns
-------
out : ndarray of bools
Medial axis transform of the image
dist : ndarray of ints, optional
Distance transform of the image (only returned if `return_distance`
is True)