Merge pull request #1022 from jni/medial_axis

Clarify `mask` argument in `medial_axis` docstring
This commit is contained in:
Johannes Schönberger
2014-06-11 13:14:40 -04:00
+6 -10
View File
@@ -163,23 +163,19 @@ def medial_axis(image, mask=None, return_distance=False):
Parameters
----------
image : binary ndarray
mask : binary ndarray, optional
If a mask is given, only those elements with a true value in `mask`
are used for computing the medial axis.
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
dist : ndarray of ints, optional
Distance transform of the image (only returned if `return_distance`
is True)