From b4c190e5603ceca651dff1628b548b24613511a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Tue, 12 Nov 2013 08:27:14 +0100 Subject: [PATCH] Explicitly set sigma value to 0 to avoid warning --- TODO.txt | 2 ++ skimage/segmentation/slic_superpixels.py | 9 ++++++--- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/TODO.txt b/TODO.txt index 3cbf4b53..4e029d28 100644 --- a/TODO.txt +++ b/TODO.txt @@ -4,6 +4,7 @@ Version 0.10 * Remove deprecated parameter `epsilon` of `skimage.viewer.LineProfile` * Remove backwards-compatability of `skimage.measure.regionprops` * Remove {`ratio`, `sigma`} deprecation warnings of `skimage.segmentation.slic` + and also remove explicit `sigma` parameter from doc-string example * Change default mode of random_walker segmentation to 'cg_mg' > 'cg' > 'bf', depending on which optional dependencies are available. * Remove deprecated `out` parameter of `skimage.morphology.binary_*` @@ -13,3 +14,4 @@ Version 0.10 * Remove deprecated `skimage.color.is_gray` and `skimage.color.is_rgb` functions + diff --git a/skimage/segmentation/slic_superpixels.py b/skimage/segmentation/slic_superpixels.py index 8276b1a8..21df45fd 100644 --- a/skimage/segmentation/slic_superpixels.py +++ b/skimage/segmentation/slic_superpixels.py @@ -87,9 +87,12 @@ def slic(image, n_segments=100, compactness=10., max_iter=10, sigma=None, >>> from skimage.segmentation import slic >>> from skimage.data import lena >>> img = lena() - >>> segments = slic(img, n_segments=100, compactness=10) - >>> # Increasing the compactness parameter yields more square regions - >>> segments = slic(img, n_segments=100, compactness=20) + >>> segments = slic(img, n_segments=100, compactness=10, sigma=0) + + Increasing the compactness parameter yields more square regions: + + >>> segments = slic(img, n_segments=100, compactness=20, sigma=0) + """ if sigma is None: