Mercurial > hg > octave-image
changeset 651:0d5958711749
image: use @dots{} for help text
author | carandraug |
---|---|
date | Wed, 10 Oct 2012 13:22:49 +0000 |
parents | b75c3b1ad7a5 |
children | 99c2c68d53de |
files | inst/colfilt.m inst/edge.m inst/entropyfilt.m inst/imfilter.m inst/immaximas.m inst/imperspectivewarp.m inst/imremap.m inst/rangefilt.m |
diffstat | 8 files changed, 12 insertions(+), 12 deletions(-) [+] |
line wrap: on
line diff
--- a/inst/colfilt.m +++ b/inst/colfilt.m @@ -2,15 +2,15 @@ ## This program is granted to the public domain. ## -*- texinfo -*- -## @deftypefn {Function File} colfilt(@var{A}, [@var{r}, @var{c}], [@var{m}, @var{n}], 'sliding', @var{f},...) +## @deftypefn {Function File} colfilt(@var{A}, [@var{r}, @var{c}], [@var{m}, @var{n}], 'sliding', @var{f},@dots{}) ## Apply filter to matrix blocks ## ## For each @var{r} x @var{c} overlapping subblock of @var{A}, add a column in matrix @var{C} -## @var{f}(@var{C},...) should return a row vector which is then reshaped into a +## @var{f}(@var{C},@dots{}) should return a row vector which is then reshaped into a ## a matrix of size @var{A} and returned. @var{A} is processed in chunks of size @var{m} x @var{n}. -## @deftypefnx{Function File} colfilt(@var{A}, [@var{r}, @var{c}], [@var{m}, @var{n}], 'distinct', @var{f},...) +## @deftypefnx{Function File} colfilt(@var{A}, [@var{r}, @var{c}], [@var{m}, @var{n}], 'distinct', @var{f},@dots{}) ## For each @var{r} x @var{c} non-overlapping subblock of @var{A}, add a column in matrix @var{C} -## @var{f}(@var{C},...) should return a matrix of size @var{C} each column of which is +## @var{f}(@var{C},@dots{}) should return a matrix of size @var{C} each column of which is ## placed back into the subblock from whence it came. @var{A} is processed ## in chunks of size @var{m} x @var{n}. ##
--- a/inst/edge.m +++ b/inst/edge.m @@ -16,7 +16,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{bw} =} edge (@var{im}, @var{method}) ## @deftypefnx{Function File} {@var{bw} =} edge (@var{im}, @var{method}, @var{arg1}, @var{arg2}) -## @deftypefnx{Function File} {[@var{bw}, @var{thresh}] =} edge (...) +## @deftypefnx{Function File} {[@var{bw}, @var{thresh}] =} edge (@dots{}) ## Detect edges in the given image using various methods. The first input @var{im} ## is the gray scale image in which edges are to be detected. The second argument ## controls which method is used for detecting the edges. The rest of the input
--- a/inst/entropyfilt.m +++ b/inst/entropyfilt.m @@ -16,7 +16,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{E} =} entropyfilt (@var{im}) ## @deftypefnx{Function File} {@var{E} =} entropyfilt (@var{im}, @var{domain}) -## @deftypefnx{Function File} {@var{E} =} entropyfilt (@var{im}, @var{domain}, @var{padding}, ...) +## @deftypefnx{Function File} {@var{E} =} entropyfilt (@var{im}, @var{domain}, @var{padding}, @dots{}) ## Computes the local entropy in a neighbourhood around each pixel in an image. ## ## The entropy of the elements of the neighbourhood is computed as
--- a/inst/imfilter.m +++ b/inst/imfilter.m @@ -15,7 +15,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} @var{J} = imfilter(@var{I}, @var{f}) -## @deftypefnx{Function File} @var{J} = imfilter(@var{I}, @var{f}, @var{options}, ...) +## @deftypefnx{Function File} @var{J} = imfilter(@var{I}, @var{f}, @var{options}, @dots{}) ## Computes the linear filtering of the image @var{I} and the filter @var{f}. ## The computation is performed using double precision floating point numbers, ## but the class of the input image is preserved as the following example shows.
--- a/inst/immaximas.m +++ b/inst/immaximas.m @@ -20,8 +20,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{r}, @var{c}] =} immaximas (@var{im}, @var{radius}) ## @deftypefnx{Function File} {[@var{r}, @var{c}] =} immaximas (@var{im}, @var{radius}, @var{thresh}) -## @deftypefnx{Function File} {[@var{r}, @var{c}, ...] =} immaximas (...) -## @deftypefnx{Function File} {[..., @var{val}] =} immaximas (...) +## @deftypefnx{Function File} {[@var{r}, @var{c}, @dots{}] =} immaximas (@dots{}) +## @deftypefnx{Function File} {[@dots{}, @var{val}] =} immaximas (@dots{}) ## Finds local spatial maximas of the given image. A local spatial maxima is ## defined as an image point with a value that is larger than all neighbouring ## values in a square region of width 2*@var{radius}+1. By default @var{radius}
--- a/inst/imperspectivewarp.m +++ b/inst/imperspectivewarp.m @@ -15,7 +15,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} @var{warped} = imperspectivewarp(@var{im}, @var{P}, @var{interp}, @var{bbox}, @var{extrapval}) -## @deftypefnx{Function File} [@var{warped}, @var{valid}] = imperspectivewarp(...) +## @deftypefnx{Function File} [@var{warped}, @var{valid}] = imperspectivewarp(@dots{}) ## Applies the spatial perspective homogeneous transformation @var{P} to the image @var{im}. ## The transformation matrix @var{P} must be a 3x3 homogeneous matrix, or 2x2 or 2x3 ## affine transformation matrix.
--- a/inst/imremap.m +++ b/inst/imremap.m @@ -16,7 +16,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} @var{warped} = imremap(@var{im}, @var{XI}, @var{YI}) ## @deftypefnx{Function File} @var{warped} = imremap(@var{im}, @var{XI}, @var{YI}, @var{interp}, @var{extrapval}) -## @deftypefnx{Function File} [@var{warped}, @var{valid} ] = imremap(...) +## @deftypefnx{Function File} [@var{warped}, @var{valid} ] = imremap(@dots{}) ## Applies any geometric transformation to the image @var{im}. ## ## The arguments @var{XI} and @var{YI} are lookup tables that define the resulting
--- a/inst/rangefilt.m +++ b/inst/rangefilt.m @@ -16,7 +16,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{R} =} rangefilt (@var{im}) ## @deftypefnx{Function File} {@var{R} =} rangefilt (@var{im}, @var{domain}) -## @deftypefnx{Function File} {@var{R} =} rangefilt (@var{im}, @var{domain}, @var{padding}, ...) +## @deftypefnx{Function File} {@var{R} =} rangefilt (@var{im}, @var{domain}, @var{padding}, @dots{}) ## Computes the local intensity range in a neighbourhood around each pixel in ## an image. ##