From e8cd48b8aecd54a547ac632a69dc005d24199938 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Boulogne?= Date: Mon, 10 Nov 2014 08:09:26 +0100 Subject: [PATCH] DOC: enhance docstring --- skimage/draw/_draw.pyx | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/skimage/draw/_draw.pyx b/skimage/draw/_draw.pyx index 69dd1075..2e6042e0 100644 --- a/skimage/draw/_draw.pyx +++ b/skimage/draw/_draw.pyx @@ -22,12 +22,14 @@ def _coords_inside_image(rr, cc, shape, val=None): Image shape which is used to determine maximum extents of output pixel coordinates. val : ndarray of float - Values of pixels. + Values of pixels at coordinates [rr, cc]. Returns ------- - rr, cc, val : (N,) ndarray (int, int, float) - Indices of pixels (and values if specified) inside the shape. + rr, cc : (N,) array of int + Row and column indices of valid pixels (i.e. those inside `shape`). + val : (N,) array of float, optional + Values at `rr, cc`. Returned only if `val` is given as input. """ mask = (rr >= 0) & (rr < shape[0]) & (cc >= 0) & (cc < shape[1]) if val is not None: