Mercurial > octave-antonio

comparison scripts/signal/filter2.m @ 20165:f1d0f506ee78 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 4197fc428c7d
children
comparison
equal deleted inserted replaced
20164:df437a52bcaf 20165:f1d0f506ee78
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {@var{y} =} filter2 (@var{b}, @var{x}) 20 ## @deftypefn {Function File} {@var{y} =} filter2 (@var{b}, @var{x})
21 ## @deftypefnx {Function File} {@var{y} =} filter2 (@var{b}, @var{x}, @var{shape}) 21 ## @deftypefnx {Function File} {@var{y} =} filter2 (@var{b}, @var{x}, @var{shape})
22 ## Apply the 2-D FIR filter @var{b} to @var{x}. If the argument 22 ## Apply the 2-D FIR filter @var{b} to @var{x}.
23 ## @var{shape} is specified, return an array of the desired shape. 23 ##
24 ## Possible values are: 24 ## If the argument @var{shape} is specified, return an array of the desired
25 ## shape. Possible values are:
25 ## 26 ##
26 ## @table @asis 27 ## @table @asis
27 ## @item @qcode{"full"} 28 ## @item @qcode{"full"}
28 ## pad @var{x} with zeros on all sides before filtering. 29 ## pad @var{x} with zeros on all sides before filtering.
29 ## 30 ##
32 ## 33 ##
33 ## @item @qcode{"valid"} 34 ## @item @qcode{"valid"}
34 ## trim @var{x} after filtering so edge effects are no included. 35 ## trim @var{x} after filtering so edge effects are no included.
35 ## @end table 36 ## @end table
36 ## 37 ##
37 ## Note this is just a variation on convolution, with the parameters 38 ## Note this is just a variation on convolution, with the parameters reversed
38 ## reversed and @var{b} rotated 180 degrees. 39 ## and @var{b} rotated 180 degrees.
39 ## @seealso{conv2} 40 ## @seealso{conv2}
40 ## @end deftypefn 41 ## @end deftypefn
41 42
42 ## Author: Paul Kienzle <pkienzle@users.sf.net> 43 ## Author: Paul Kienzle <pkienzle@users.sf.net>
43 ## 2001-02-08 44 ## 2001-02-08