octave-antonio: scripts/signal/filter2.m annotate

annotate scripts/signal/filter2.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	4197fc428c7d
children

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 2001-2015 Paul Kienzle
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	2 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	3 ## This file is part of Octave.
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	4 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6575 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6575 diff changeset	8 ## your option) any later version.
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	9 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	13 ## General Public License for more details.
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	14 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6575 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6575 diff changeset	17 ## <http://www.gnu.org/licenses/>.
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	18
5996 bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman] dbateman parents: 5820 diff changeset	19 ## -- texinfo --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	20 ## @deftypefn {Function File} {@var{y} =} filter2 (@var{b}, @var{x})
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 6046 diff changeset	21 ## @deftypefnx {Function File} {@var{y} =} filter2 (@var{b}, @var{x}, @var{shape})
20165 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	22 ## Apply the 2-D FIR filter @var{b} to @var{x}.
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	23 ##
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	24 ## If the argument @var{shape} is specified, return an array of the desired
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	25 ## shape. Possible values are:
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	26 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	27 ## @table @asis
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 14868 diff changeset	28 ## @item @qcode{"full"}
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	29 ## pad @var{x} with zeros on all sides before filtering.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	30 ##
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 14868 diff changeset	31 ## @item @qcode{"same"}
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	32 ## unpadded @var{x} (default)
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	33 ##
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 14868 diff changeset	34 ## @item @qcode{"valid"}
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	35 ## trim @var{x} after filtering so edge effects are no included.
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	36 ## @end table
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	37 ##
20165 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	38 ## Note this is just a variation on convolution, with the parameters reversed
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	39 ## and @var{b} rotated 180 degrees.
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	40 ## @seealso{conv2}
5996 bd0507994409 [project @ 2006-09-22 19:38:52 by dbateman] dbateman parents: 5820 diff changeset	41 ## @end deftypefn
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	42
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	43 ## Author: Paul Kienzle <pkienzle@users.sf.net>
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	44 ## 2001-02-08
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	45 ## * initial release
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	46
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	47 function y = filter2 (b, x, shape)
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	48
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	49 if (nargin < 2 \|\| nargin > 3)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5997 diff changeset	50 print_usage ();
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	51 endif
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	52 if (nargin < 3)
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	53 shape = "same";
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	54 endif
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	55
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14359 diff changeset	56 [nr, nc] = size (b);
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	57 y = conv2 (x, b(nr:-1:1, nc:-1:1), shape);
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	58 endfunction
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	59

Mercurial > octave-antonio

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