Mercurial > octave-antonio
comparison scripts/signal/spectral_xdf.m @ 20165:f1d0f506ee78 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed optimization, polynomial, signal script directories.
* scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/pqpnonneg.m,
scripts/optimization/qp.m, scripts/optimization/sqp.m,
scripts/polynomial/compan.m, scripts/polynomial/mkpp.m,
scripts/polynomial/mpoles.m, scripts/polynomial/pchip.m,
scripts/polynomial/poly.m, scripts/polynomial/polyaffine.m,
scripts/polynomial/polyder.m, scripts/polynomial/polyeig.m,
scripts/polynomial/polyfit.m, scripts/polynomial/polygcd.m,
scripts/polynomial/polyint.m, scripts/polynomial/polyout.m,
scripts/polynomial/polyval.m, scripts/polynomial/ppder.m,
scripts/polynomial/ppint.m, scripts/polynomial/ppjumps.m,
scripts/polynomial/ppval.m, scripts/polynomial/residue.m,
scripts/polynomial/roots.m, scripts/polynomial/spline.m,
scripts/polynomial/splinefit.m, scripts/polynomial/unmkpp.m,
scripts/signal/arch_fit.m, scripts/signal/arch_rnd.m,
scripts/signal/arma_rnd.m, scripts/signal/autoreg_matrix.m,
scripts/signal/bartlett.m, scripts/signal/blackman.m, scripts/signal/detrend.m,
scripts/signal/diffpara.m, scripts/signal/durbinlevinson.m,
scripts/signal/fftconv.m, scripts/signal/fftfilt.m, scripts/signal/fftshift.m,
scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/hamming.m,
scripts/signal/hanning.m, scripts/signal/hurst.m, scripts/signal/ifftshift.m,
scripts/signal/periodogram.m, scripts/signal/sinc.m, scripts/signal/sinetone.m,
scripts/signal/sinewave.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/signal/spencer.m, scripts/signal/stft.m,
scripts/signal/synthesis.m, scripts/signal/unwrap.m,
scripts/signal/yulewalker.m:
Update more docstrings to have one sentence summary as first line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 04 May 2015 21:50:57 -0700 |
| parents | 9fc020886ae9 |
| children |
comparison
equal
deleted
inserted
replaced
| 20164:df437a52bcaf | 20165:f1d0f506ee78 |
|---|---|
| 18 | 18 |
| 19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {} spectral_xdf (@var{x}) | 20 ## @deftypefn {Function File} {} spectral_xdf (@var{x}) |
| 21 ## @deftypefnx {Function File} {} spectral_xdf (@var{x}, @var{win}) | 21 ## @deftypefnx {Function File} {} spectral_xdf (@var{x}, @var{win}) |
| 22 ## @deftypefnx {Function File} {} spectral_xdf (@var{x}, @var{win}, @var{b}) | 22 ## @deftypefnx {Function File} {} spectral_xdf (@var{x}, @var{win}, @var{b}) |
| 23 ## Return the spectral density estimator given a data vector @var{x}, | 23 ## Return the spectral density estimator given a data vector @var{x}, window |
| 24 ## window name @var{win}, and bandwidth, @var{b}. | 24 ## name @var{win}, and bandwidth, @var{b}. |
| 25 ## | 25 ## |
| 26 ## The window name, e.g., @qcode{"triangle"} or @qcode{"rectangle"} is | 26 ## The window name, e.g., @qcode{"triangle"} or @qcode{"rectangle"} is used to |
| 27 ## used to search for a function called @code{@var{win}_sw}. | 27 ## search for a function called @code{@var{win}_sw}. |
| 28 ## | 28 ## |
| 29 ## If @var{win} is omitted, the triangle window is used. If @var{b} is | 29 ## If @var{win} is omitted, the triangle window is used. |
| 30 ## omitted, @code{1 / sqrt (length (@var{x}))} is used. | 30 ## |
| 31 ## If @var{b} is omitted, @code{1 / sqrt (length (@var{x}))} is used. | |
| 31 ## @seealso{spectral_adf} | 32 ## @seealso{spectral_adf} |
| 32 ## @end deftypefn | 33 ## @end deftypefn |
| 33 | 34 |
| 34 ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> | 35 ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> |
| 35 ## Description: Spectral density estimation | 36 ## Description: Spectral density estimation |