Mercurial > forge

changeset 11088:a63621e0e963 octave-forge

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bwlabeln: Document connectivity mask in docstring
author jordigh
date Mon, 15 Oct 2012 18:47:27 +0000
parents ae932ce56de8
children 30b978a3b036
files main/image/src/bwlabeln.cc
diffstat 1 files changed, 4 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/main/image/src/bwlabeln.cc	Mon Oct 15 14:26:54 2012 +0000
+++ b/main/image/src/bwlabeln.cc	Mon Oct 15 18:47:27 2012 +0000
@@ -275,7 +275,10 @@
 @deftypefnx {Loadable Function} {[@var{l}, @var{num}] =} bwlabeln(@var{bw}, @var{n})\n\
 Label foreground objects in the n-dimensional binary image @var{bw}.\n\
 \n\
-The optional argument @var{n} sets the connectivity and defaults 26.\n\
+The optional argument @var{n} sets the connectivity and defaults 26,\n\
+for 26-connectivity in 3-D images. Other possible values are 18 and 6\n\
+for 3-D images, 4 and 8 for 2-D images, or an arbitrary N-dimensional\n\
+binary connectivity mask where each dimension is of size 3.\n\
 \n\
 The output @var{l} is an Nd-array where 0 indicates a background\n\
 pixel, 1 indicates that the pixel belong to object number 1, 2 that\n\