changeset 544:5127beba4f52

help text: functions in oct files are {Loadable Functions}, not {Function Files}. Fixing help texts accordingly
author carandraug
date Fri, 16 Mar 2012 03:58:03 +0000
parents c47fa2969872
children 23a7bdae105c
files src/__boundary__.cc src/__bwdist.cc src/bwfill.cc src/bwlabel.cc src/bwlabeln.cc src/graycomatrix.cc src/nonmax_supress.cc src/rotate_scale.cc
diffstat 8 files changed, 13 insertions(+), 13 deletions(-) [+]
line wrap: on
line diff
--- a/src/__boundary__.cc
+++ b/src/__boundary__.cc
@@ -27,8 +27,8 @@
 
 DEFUN_DLD(__boundary__, args, nargout,
 "-*- texinfo -*-\n\
-@deftypefn {Function File} {@var{b} = } boundary(@var{region})\n\
-@deftypefnx {Function File} {@var{b} = } boundary(@var{region}, @var{conn})\n\
+@deftypefn {Loadable Function} {@var{b} = } boundary(@var{region})\n\
+@deftypefnx {Loadable Function} {@var{b} = } boundary(@var{region}, @var{conn})\n\
 Trace the boundary of an object in a binary image.\n\
 \n\
 @code{boundary} computes the exterior clockwise boundary of the single \
--- a/src/__bwdist.cc
+++ b/src/__bwdist.cc
@@ -64,7 +64,7 @@
 
 DEFUN_DLD ( __bwdist, args, nargout,
 "-*- texinfo -*-\n\
-@deftypefn {Function File} {@var{D} =} __bwdist(@var{bw})\n\
+@deftypefn {Loadable Function} {@var{D} =} __bwdist(@var{bw})\n\
 Computes the distance transform of the image @var{bw}.\n\
 @var{bw} should be a binary 2D array, either a Boolean array or a\n\
 numeric array containing only the values 0 and 1.\n\
@@ -75,7 +75,7 @@
 metric) to the closest object pixel. For each object pixel the\n\
 return value is 0.\n\
 \n\
-@deftypefnx{Function File} {@var{D} =} __bwdist(@var{bw}, @var{method})\n\
+@deftypefnx{Loadable Function} {@var{D} =} __bwdist(@var{bw}, @var{method})\n\
 \n\
 @var{method} is a string to choose the distance metric. Currently\n\
 available metrics are 'euclidean', 'chessboard', 'cityblock' and\n\
@@ -83,7 +83,7 @@
 to any string starting with 'e', 'ch', 'ci' and 'q', respectively.\n\
 If @var{method} is not specified, 'euclidean' is the default.\n\
 \n\
-@deftypefnx {Function File} {[@var{D},@var{C}] =} __bwdist(@var{bw}, @var{method})\n\
+@deftypefnx {Loadable Function} {[@var{D},@var{C}] =} __bwdist(@var{bw}, @var{method})\n\
 \n\
 If a second output argument is given, the linear index for the\n\
 closest object pixel is returned for each pixel. (For object\n\
--- a/src/bwfill.cc
+++ b/src/bwfill.cc
@@ -25,7 +25,7 @@
 
 DEFUN_DLD (bwfill, args, ,"\
 -*- texinfo -*-\n\
-@deftypefn {Function File} {[@var{bw2}, @var{idx}] =} bwfill(@var{bw1}, @var{c}, @var{r}, @var{n})\n\
+@deftypefn {Loadable Function} {[@var{bw2}, @var{idx}] =} bwfill(@var{bw1}, @var{c}, @var{r}, @var{n})\n\
 Perform a flood-fill operation on the binary image @var{bw1}.\n\
 The flood-filling starts in the pixel (@var{r}, @var{c}). If @var{r} and @var{c}\n\
 are vectors of the same length, each pixel pair (@var{r}(i), @var{c}(i)) will\n\
@@ -35,7 +35,7 @@
 \n\
 The output is the processed image @var{bw2} and the indexes of the filled\n\
 pixels @var{idx}\n\
-@deftypefnx{Function File} {[@var{bw2}, @var{idx}] =} bwfill(@var{bw1}, \"holes\", @var{n})\n\
+@deftypefnx{Loadable Function} {[@var{bw2}, @var{idx}] =} bwfill(@var{bw1}, \"holes\", @var{n})\n\
 If the string \"holes\" is given instead of starting points for the flood-fill\n\
 operation, the function finds interior holes in @var{bw1} and fills them.\n\
 @end deftypefn\n\
--- a/src/bwlabel.cc
+++ b/src/bwlabel.cc
@@ -61,7 +61,7 @@
 
 DEFUN_DLD(bwlabel, args, , "\
 -*- texinfo -*-\n\
-@deftypefn {Function File} {[@var{l}, @var{num}] =} bwlabel(@var{bw}, @var{n})\n\
+@deftypefn {Loadable Function} {[@var{l}, @var{num}] =} bwlabel(@var{bw}, @var{n})\n\
 Labels foreground objects in the binary image @var{bw}.\n\
 The output @var{l} is a matrix where 0 indicates a background pixel,\n\
 1 indicates that the pixel belong to object number 1, 2 that the pixel\n\
--- a/src/bwlabeln.cc
+++ b/src/bwlabeln.cc
@@ -214,7 +214,7 @@
 
 DEFUN_DLD(bwlabeln, args, , "\
 -*- texinfo -*-\n\
-@deftypefn {Function File} {[@var{l}, @var{num}] =} bwlabeln(@var{bw}, @var{n})\n\
+@deftypefn {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\
--- a/src/graycomatrix.cc
+++ b/src/graycomatrix.cc
@@ -26,7 +26,7 @@
 
 DEFUN_DLD(graycomatrix, args, , "\
 -*- texinfo -*-\n\
-@deftypefn {Function File} {@var{P} =} graycomatrix(@var{im}, @var{levels}, @var{distances}, @var{angles})\n\
+@deftypefn {Loadable Function} {@var{P} =} graycomatrix(@var{im}, @var{levels}, @var{distances}, @var{angles})\n\
 Calculates the gray-level co-occurrence matrix @var{P} of a gray-level image @var{im}.\n\
 \n\
 @var{P} is a 4-dimensional matrix (histogram). The value @var{P}(@var{i},@var{j},@var{d},@var{theta})\n\
--- a/src/nonmax_supress.cc
+++ b/src/nonmax_supress.cc
@@ -47,13 +47,13 @@
 
 DEFUN_DLD(nonmax_supress,args,nargout,"\
 -*- texinfo -*-\n\
-@deftypefn {Function File} nonmax_supress (@var{Es}, @var{Eo})\n\
+@deftypefn {Loadable Function} nonmax_supress (@var{Es}, @var{Eo})\n\
 Performs non-maximum supression on the given edge data. \
 @var{Es} is a matrix containing the edge strength (the length of \
 the gradient), and @var{Eo} is the edge normal orientation (the \
 direction of the gradient).\n\
 \n\
-@deftypefnx {Function File} nonmax_supress (@var{Es}, @var{Eo},\
+@deftypefnx {Loadable Function} nonmax_supress (@var{Es}, @var{Eo},\
  @var{low}, @var{high} )\n\
 Performs non-maximum supression and hysteresis thresholdong, using \
 @var{low} and @var{high} as thresholds.\n\
--- a/src/rotate_scale.cc
+++ b/src/rotate_scale.cc
@@ -31,7 +31,7 @@
 
 DEFUN_DLD (rotate_scale, args, , "\
 -*- texinfo -*-\n\
-@deftypefn {Function File} {@var{im1} =} rotate_scale(@var{im0}, @var{lm0}, @var{lm1}, @var{out_size})\n\
+@deftypefn {Loadable Function} {@var{im1} =} rotate_scale(@var{im0}, @var{lm0}, @var{lm1}, @var{out_size})\n\
 Arbitrary rotation and scaling of a gray-scale image using fast bilinear interpolation.\n\
 \n\
 The image @var{im0} will be rotated and scaled such that the landmark points in\n\