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

Improve doc string layout

Browse Source
This commit is contained in:
Johannes Schönberger
2012-09-02 10:34:09 +02:00
parent 224fcb5d01
commit 2842515dc3
1 changed files with 34 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skimage/morphology/grey.py
+34 -43
View File
@@ -28,15 +28,12 @@ def erosion(image, selem, out=None, shift_x=False, shift_y=False):
Parameters
----------
image : ndarray
Image array.
Image array.
selem : ndarray
The neighborhood expressed as a 2-D array of 1's and 0's.
The neighborhood expressed as a 2-D array of 1's and 0's.
out : ndarray
The array to store the result of the morphology. If None is
passed, a new array will be allocated.
The array to store the result of the morphology. If None is
passed, a new array will be allocated.
shift_x, shift_y : bool
shift structuring element about center point. This only affects
eccentric structuring elements (i.e. selem with even numbered sides).
@@ -44,7 +41,7 @@ def erosion(image, selem, out=None, shift_x=False, shift_y=False):
Returns
-------
eroded : uint8 array
The result of the morphological erosion.
The result of the morphological erosion.
Examples
--------
@@ -63,6 +60,7 @@ def erosion(image, selem, out=None, shift_x=False, shift_y=False):
[0, 0, 0, 0, 0]], dtype='uint8')
"""
if image is out:
raise NotImplementedError("In-place erosion not supported!")
image = skimage.img_as_ubyte(image)
@@ -82,15 +80,12 @@ def dilation(image, selem, out=None, shift_x=False, shift_y=False):
----------
image : ndarray
Image array.
Image array.
selem : ndarray
The neighborhood expressed as a 2-D array of 1's and 0's.
The neighborhood expressed as a 2-D array of 1's and 0's.
out : ndarray
The array to store the result of the morphology. If None, is
passed, a new array will be allocated.
The array to store the result of the morphology. If None, is
passed, a new array will be allocated.
shift_x, shift_y : bool
shift structuring element about center point. This only affects
eccentric structuring elements (i.e. selem with even numbered sides).
@@ -98,7 +93,7 @@ def dilation(image, selem, out=None, shift_x=False, shift_y=False):
Returns
-------
dilated : uint8 array
The result of the morphological dilation.
The result of the morphological dilation.
Examples
--------
@@ -117,6 +112,7 @@ def dilation(image, selem, out=None, shift_x=False, shift_y=False):
[0, 0, 0, 0, 0]], dtype='uint8')
"""
if image is out:
raise NotImplementedError("In-place dilation not supported!")
image = skimage.img_as_ubyte(image)
@@ -136,19 +132,17 @@ def opening(image, selem, out=None):
Parameters
----------
image : ndarray
Image array.
Image array.
selem : ndarray
The neighborhood expressed as a 2-D array of 1's and 0's.
The neighborhood expressed as a 2-D array of 1's and 0's.
out : ndarray
The array to store the result of the morphology. If None
is passed, a new array will be allocated.
The array to store the result of the morphology. If None
is passed, a new array will be allocated.
Returns
-------
opening : uint8 array
The result of the morphological opening.
The result of the morphological opening.
Examples
--------
@@ -167,6 +161,7 @@ def opening(image, selem, out=None):
[0, 0, 0, 0, 0]], dtype='uint8')
"""
h, w = selem.shape
shift_x = True if (w % 2) == 0 else False
shift_y = True if (h % 2) == 0 else False
@@ -187,19 +182,17 @@ def closing(image, selem, out=None):
Parameters
----------
image : ndarray
Image array.
Image array.
selem : ndarray
The neighborhood expressed as a 2-D array of 1's and 0's.
The neighborhood expressed as a 2-D array of 1's and 0's.
out : ndarray
The array to store the result of the morphology. If None,
is passed, a new array will be allocated.
The array to store the result of the morphology. If None,
is passed, a new array will be allocated.
Returns
-------
closing : uint8 array
The result of the morphological closing.
The result of the morphological closing.
Examples
--------
@@ -218,6 +211,7 @@ def closing(image, selem, out=None):
[0, 0, 0, 0, 0]], dtype='uint8')
"""
h, w = selem.shape
shift_x = True if (w % 2) == 0 else False
shift_y = True if (h % 2) == 0 else False
@@ -237,19 +231,17 @@ def white_tophat(image, selem, out=None):
Parameters
----------
image : ndarray
Image array.
Image array.
selem : ndarray
The neighborhood expressed as a 2-D array of 1's and 0's.
The neighborhood expressed as a 2-D array of 1's and 0's.
out : ndarray
The array to store the result of the morphology. If None
is passed, a new array will be allocated.
The array to store the result of the morphology. If None
is passed, a new array will be allocated.
Returns
-------
opening : uint8 array
The result of the morphological white top hat.
The result of the morphological white top hat.
Examples
--------
@@ -288,14 +280,12 @@ def black_tophat(image, selem, out=None):
Parameters
----------
image : ndarray
Image array.
Image array.
selem : ndarray
The neighborhood expressed as a 2-D array of 1's and 0's.
The neighborhood expressed as a 2-D array of 1's and 0's.
out : ndarray
The array to store the result of the morphology. If None
is passed, a new array will be allocated.
The array to store the result of the morphology. If None
is passed, a new array will be allocated.
Returns
-------
@@ -319,6 +309,7 @@ def black_tophat(image, selem, out=None):
[0, 0, 0, 0, 0]], dtype='uint8')
"""
if image is out:
raise NotImplementedError("Cannot perform white top hat in place.")
image = skimage.img_as_ubyte(image)