Mercurial > forge

changeset 11385:8856f81a926a octave-forge

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
xcorr2: small improv on documentation explaining coeff option
author carandraug
date Mon, 14 Jan 2013 01:44:45 +0000
parents e49f79b744f3
children 909720f86805
files main/signal/inst/xcorr2.m
diffstat 1 files changed, 5 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/main/signal/inst/xcorr2.m	Mon Jan 14 01:03:03 2013 +0000
+++ b/main/signal/inst/xcorr2.m	Mon Jan 14 01:44:45 2013 +0000
@@ -16,9 +16,9 @@
 ## this program; if not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{c} =} xcorr2 (@var{a})
-## @deftypefnx {Function File} {@var{c} =} xcorr2 (@var{a}, @var{b})
-## @deftypefnx {Function File} {@var{c} =} xcorr2 (@dots{}, @var{scale})
+## @deftypefn  {Function File} {} xcorr2 (@var{a})
+## @deftypefnx {Function File} {} xcorr2 (@var{a}, @var{b})
+## @deftypefnx {Function File} {} xcorr2 (@dots{}, @var{scale})
 ## Compute the 2D cross-correlation of matrices @var{a} and @var{b}.
 ##
 ## If @var{b} is not specified, computes autocorrelation of @var{a}, i.e.,
@@ -41,7 +41,8 @@
 ## element.
 ##
 ## @item "coeff"
-## Returns the normalized cross-correlation.
+## Scales the normalized cross-correlation on the range of [0 1] so that a value
+## of 1 corresponds to a correlation coefficient of 1.
 ## @end table
 ##
 ## @seealso{conv2, corr2, xcorr}