[Octave-cvsupdate] SF.net SVN: octave:[10862] trunk/octave-forge/extra/lssa/inst/lscorrcoeff.m

[<be...@us...>]

Revision: 10862
          http://octave.svn.sourceforge.net/octave/?rev=10862&view=rev
Author:   benjf5
Date:     2012-08-14 16:51:37 +0000 (Tue, 14 Aug 2012)
Log Message:
-----------
Fixed help string that wouldn't have a proper first line in lssa.

Modified Paths:
--------------
    trunk/octave-forge/extra/lssa/inst/lscorrcoeff.m

Modified: trunk/octave-forge/extra/lssa/inst/lscorrcoeff.m
===================================================================
--- trunk/octave-forge/extra/lssa/inst/lscorrcoeff.m	2012-08-14 16:27:34 UTC (rev 10861)
+++ trunk/octave-forge/extra/lssa/inst/lscorrcoeff.m	2012-08-14 16:51:37 UTC (rev 10862)
@@ -18,14 +18,15 @@
 ## @deftypefnx {Function File} {@var{c} =} lscorrcoeff (@var{time1}, @var{mag1}, @var{time2}, @var{mag2}, @var{time}, @var{freq}, @var{window} = @var{cubicwgt})
 ## @deftypefnx {Function File} {@var{c} =} lscorrcoeff (@var{time1}, @var{mag1}, @var{time2}, @var{mag2}, @var{time}, @var{freq}, @var{window} = @var{cubicwgt}, @var{winradius} = 1)
 ##
-## Return the coefficient of the wavelet correlation of two complex-valued time
-## series at a given time and frequency.  The windowing function applied by
-## default is cubicwgt, this can be changed by passing a different function
-## handle to @var{window}, while the radius applied is set by @var{winradius}.
-## Note that this will be most effective when both series have had their mean
-## value (if it is not zero) subtracted (and stored separately); this reduces
-## the constant-offset error further, and allows the functions to be compared on
-## their periodic features rather than their constant features.
+## Return the coefficient of the wavelet correlation of two complex time
+## series.  The correlation is only effective at a given time and frequency.
+## The windowing function applied by default is cubicwgt, this can be changed by
+## passing a different function handle to @var{window}, while the radius applied
+## is set by @var{winradius}.  Note that this will be most effective when both
+## series have had their mean value (if it is not zero) subtracted (and stored
+## separately); this reduces the constant-offset error further, and allows the
+## functions to be compared on their periodic features rather than their
+## constant features.
 ##
 ## @seealso{lswaveletcoeff, lscomplexwavelet, lsrealwavelet}
 ## 

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