Mercurial > octave-antonio
comparison scripts/signal/detrend.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 |
|---|---|
| 22 ## best fit of a polynomial of order @var{p} from the data @var{x}. | 22 ## best fit of a polynomial of order @var{p} from the data @var{x}. |
| 23 ## | 23 ## |
| 24 ## If @var{x} is a matrix, @code{detrend (@var{x}, @var{p})} does the same | 24 ## If @var{x} is a matrix, @code{detrend (@var{x}, @var{p})} does the same |
| 25 ## for each column in @var{x}. | 25 ## for each column in @var{x}. |
| 26 ## | 26 ## |
| 27 ## The second argument is optional. If it is not specified, a value of 1 | 27 ## The second argument @var{p} is optional. If it is not specified, a value of |
| 28 ## is assumed. This corresponds to removing a linear trend. | 28 ## 1 is assumed. This corresponds to removing a linear trend. |
| 29 ## | 29 ## |
| 30 ## The order of the polynomial can also be given as a string, in which case | 30 ## The order of the polynomial can also be given as a string, in which case |
| 31 ## @var{p} must be either @qcode{"constant"} (corresponds to | 31 ## @var{p} must be either @qcode{"constant"} (corresponds to @code{@var{p}=0}) |
| 32 ## @code{@var{p}=0}) or | 32 ## or @qcode{"linear"} (corresponds to @code{@var{p}=1}). |
| 33 ## @qcode{"linear"} (corresponds to @code{@var{p}=1}). | |
| 34 ## @seealso{polyfit} | 33 ## @seealso{polyfit} |
| 35 ## @end deftypefn | 34 ## @end deftypefn |
| 36 | 35 |
| 37 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> | 36 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> |
| 38 ## Created: 11 October 1994 | 37 ## Created: 11 October 1994 |