Mercurial > hg > octave-image
changeset 364:9436766036ed
All new file to support new version of __bwdist.cc
author | stegu |
---|---|
date | Sat, 18 Apr 2009 12:19:29 +0000 |
parents | 7fda62a0897b |
children | ef5d0e8962fe |
files | inst/bwdist.m |
diffstat | 1 files changed, 37 insertions(+), 26 deletions(-) [+] |
line wrap: on
line diff
--- a/inst/bwdist.m +++ b/inst/bwdist.m @@ -1,4 +1,4 @@ -## Copyright (C) 2006 Søren Hauberg +## Copyright (C) 2006 Stefan Gustavson ## ## This program is free software; you can redistribute it and/or modify ## it under the terms of the GNU General Public License as published by @@ -14,37 +14,48 @@ ## along with this file. If not, see <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} @var{d} = bwdist(@var{bw}, @var{method}) -## Computes the distance transform of the binary image @var{bw}. -## The result @var{d} is a matrix of the same size as @var{bw}, where -## each value is the shortest distance to a non-zero pixel in @var{bw}. +## @deftypefn {Function File} {@var{D} =} bwdist(@var{bw}) +## +## Computes the distance transform of the image @var{bw}. +## @var{bw} should be a binary 2D array, either a Boolean array or a +## numeric array containing only the values 0 and 1. +## The return value @var{D} is a double matrix of the same size as @var{bw}. +## Elements with value 0 are considered background pixels, elements +## with value 1 are considered object pixels. The return value +## for each background pixel is the distance (according to the chosen +## metric) to the closest object pixel. For each object pixel the +## return value is 0. ## -## @var{method} changes the used distance function. Currently -## the Euclidian distance is the only supported distance function. +## @deftypefnx{Function File} {@var{D} =} bwdist(@var{bw}, @var{method}) +## +## @var{method} is a string to choose the distance metric. Currently +## available metrics are 'euclidean', 'chessboard', 'cityblock' and +## 'quasi-euclidean', which may each be abbreviated to any string +## starting with 'e', 'ch', 'ci' and 'q', respectively. +## If @var{method} is not specified, 'euclidean' is the default. +## +## @deftypefnx {Function File} {[@var{D},@var{C}] =} bwdist(@var{bw}, @var{method}) +## +## If a second output argument is given, the linear index for the +## closest object pixel is returned for each pixel. (For object +## pixels, the index points to the pixel itself.) The return value +## @var{C} is a matrix the same size as @var{bw}. ## @end deftypefn -function D = bwdist(bw, method = "euclidian") - ## Check input - if (nargin == 0) - print_usage(); - endif - - if (!ismatrix(bw) || ndims(bw) != 2) - error("bwdist: input must be a 2-dimensional matrix"); - endif +# This M wrapper is an almost direct pass-through to an oct function, +# but it might prove useful for a future extension to handle N-D data. +# The algorithm implemented by __bwdist() is 2D-only. + +function [D, C] = bwdist(bw, method = "euclidean") if (!ischar(method)) error("bwdist: method name must be a string"); endif - ## Do the work - bw = (bw != 0); - switch (lower(method(1))) - case "e" - ## Euclidian distance transform - D = __bwdist(bw); - D = sqrt(D); - otherwise - error("bwdist: unsupported method '%s'", method); - endswitch + if (nargout < 2) + D = __bwdist(bw, method); + else + [D, C] = __bwdist(bw, method); + endif + endfunction