← Back to branch summary

~gabriel1984sibiu/octave/octave

« back to all changes in this revision

Viewing changes to scripts/signal/filter2.m

  • Committer: Grevutiu Gabriel
  • Date: 2014-01-02 13:05:54 UTC
  • Revision ID: gabriel1984sibiu@gmail.com-20140102130554-3r7ivdjln1ni6kcg
New version (3.8.0) from upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
scripts/signal/filter2.m
 
1
## Copyright (C) 2001-2013 Paul Kienzle
 
2
##
 
3
## This file is part of Octave.
 
4
##
 
5
## Octave is free software; you can redistribute it and/or modify it
 
6
## under the terms of the GNU General Public License as published by
 
7
## the Free Software Foundation; either version 3 of the License, or (at
 
8
## your option) any later version.
 
9
##
 
10
## Octave is distributed in the hope that it will be useful, but
 
11
## WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
13
## General Public License for more details.
 
14
##
 
15
## You should have received a copy of the GNU General Public License
 
16
## along with Octave; see the file COPYING.  If not, see
 
17
## <http://www.gnu.org/licenses/>.
 
18
 
 
19
## -*- texinfo -*-
 
20
## @deftypefn  {Function File} {@var{y} =} filter2 (@var{b}, @var{x})
 
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
 
23
## @var{shape} is specified, return an array of the desired shape.
 
24
## Possible values are:
 
25
##
 
26
## @table @asis
 
27
## @item @qcode{"full"}
 
28
## pad @var{x} with zeros on all sides before filtering.
 
29
##
 
30
## @item @qcode{"same"}
 
31
## unpadded @var{x} (default)
 
32
##
 
33
## @item @qcode{"valid"}
 
34
## trim @var{x} after filtering so edge effects are no included.
 
35
## @end table
 
36
##
 
37
## Note this is just a variation on convolution, with the parameters
 
38
## reversed and @var{b} rotated 180 degrees.
 
39
## @seealso{conv2}
 
40
## @end deftypefn
 
41
 
 
42
## Author: Paul Kienzle <pkienzle@users.sf.net>
 
43
## 2001-02-08
 
44
##    * initial release
 
45
 
 
46
function y = filter2 (b, x, shape)
 
47
 
 
48
  if (nargin < 2 || nargin > 3)
 
49
    print_usage ();
 
50
  endif
 
51
  if (nargin < 3)
 
52
    shape = "same";
 
53
  endif
 
54
 
 
55
  [nr, nc] = size (b);
 
56
  y = conv2 (x, b(nr:-1:1, nc:-1:1), shape);
 
57
endfunction
 
58