wassname/scikit-image
1
0
Fork 0
mirror of https://github.com/wassname/scikit-image.git synced 2026-06-27 19:48:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

DOC: enhance docstring

Browse Source
This commit is contained in:
François Boulogne
2014-11-10 08:09:26 +01:00
parent c736ff2c1a
commit e8cd48b8ae
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skimage/draw/_draw.pyx
+5 -3
View File
@@ -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: