[Octave-cvsupdate] SF.net SVN: octave:[10905] trunk/octave-forge/main/signal/inst/xcorr2.m

[<car...@us...>]

Revision: 10905
          http://octave.svn.sourceforge.net/octave/?rev=10905&view=rev
Author:   carandraug
Date:     2012-08-24 02:56:21 +0000 (Fri, 24 Aug 2012)
Log Message:
-----------
xcorr2: improved texinfo

Modified Paths:
--------------
    trunk/octave-forge/main/signal/inst/xcorr2.m

Modified: trunk/octave-forge/main/signal/inst/xcorr2.m
===================================================================
--- trunk/octave-forge/main/signal/inst/xcorr2.m	2012-08-24 02:45:33 UTC (rev 10904)
+++ trunk/octave-forge/main/signal/inst/xcorr2.m	2012-08-24 02:56:21 UTC (rev 10905)
@@ -22,34 +22,32 @@
 ## Compute the 2D cross-correlation of matrices @var{a} and @var{b}.
 ##
 ## If @var{b} is not specified, it defaults to the same matrix as @var{a}, i.e.,
-## it's the same as @code{xcorr(@var{a}, @var{a})}.
+## same as @code{xcorr(@var{a}, @var{a})}.
 ##
 ## The optional argument @var{scale}, defines the type of scaling applied to the
-## cross-correlation matrix (defaults to "none"). Possible values are:
-## @itemize @bullet
-## @item "biased"
+## cross-correlation matrix. Possible values are:
 ##
+## @table @asis
+## @item "none" (default)
+## No scaling.
+##
+## @item "biased"
 ## Scales the raw cross-correlation by the maximum number of elements of @var{a}
 ## and @var{b} involved in the generation of any element of @var{c}.
 ##
-## @item "none"
-## No scaling (this is the default).
-##
 ## @item "unbiased"
-##
 ## Scales the raw correlation by dividing each element in the cross-correlation
 ## matrix by the number of products @var{a} and @var{b} used to generate that
-## element 
+## element.
 ##
 ## @item "coeff"
+## Normalizes the sequence dividing by the max of the cross-correlation, so that
+## the largest cross-correlation element is 1.
 ##
-## Normalizes the sequence so that the largest cross-correlation element is
-## identically 1.0.
-##
 ## @item "norm"
-##
 ## Returns the normalized cross-correlation.
-## @end itemize
+## @end table
+##
 ## @seealso{conv2, corr2, xcorr}
 ## @end deftypefn
 
@@ -69,6 +67,7 @@
 
   ## bias routines by Dave Cogdell (cog...@as...)
   ## optimized by Paul Kienzle (pki...@us...)
+  ## norm routine by Carnë Draug (car...@gm...)
   switch lower (biasflag)
     case {"none"}
       ## do nothing, it's all done

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.