annotate scripts/signal/fftfilt.m @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents 34f96dd5441b
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2326
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
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: 6046
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: 6046
diff changeset
8 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
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: 6046
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: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
18
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 2847
diff changeset
19 ## -*- texinfo -*-
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 2847
diff changeset
20 ## @deftypefn {Function File} {} fftfilt (@var{b}, @var{x}, @var{n})
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3367
diff changeset
21 ##
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 2847
diff changeset
22 ## With two arguments, @code{fftfilt} filters @var{x} with the FIR filter
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 2847
diff changeset
23 ## @var{b} using the FFT.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3367
diff changeset
24 ##
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 2847
diff changeset
25 ## Given the optional third argument, @var{n}, @code{fftfilt} uses the
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 2847
diff changeset
26 ## overlap-add method to filter @var{x} with @var{b} using an N-point FFT.
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
27 ##
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
28 ## If @var{x} is a matrix, filter each column of the matrix.
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 2847
diff changeset
29 ## @end deftypefn
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
30
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
31 ## Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
32 ## Created: 3 September 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
33 ## Adapted-By: jwe
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
34
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
35 function y = fftfilt (b, x, N)
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
36
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
37 ## If N is not specified explicitly, we do not use the overlap-add
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
38 ## method at all because loops are really slow. Otherwise, we only
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
39 ## ensure that the number of points in the FFT is the smallest power
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
40 ## of two larger than N and length(b). This could result in length
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
41 ## one blocks, but if the user knows better ...
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
42
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
43 if (nargin < 2 || nargin > 3)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5428
diff changeset
44 print_usage ();
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
45 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
46
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
47 transpose = (rows (x) == 1);
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
48
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
49 if (transpose)
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
50 x = x.';
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
51 endif
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
52
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
53 [r_x, c_x] = size (x);
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
54 [r_b, c_b] = size (b);
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
55
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
56 if min ([r_b, c_b]) != 1
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
57 error ("fftfilt: b should be a vector");
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
58 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
59
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
60 l_b = r_b * c_b;
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
61 b = reshape (b, l_b, 1);
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
62
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
63 if (nargin == 2)
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
64 ## Use FFT with the smallest power of 2 which is >= length (x) +
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
65 ## length (b) - 1 as number of points ...
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
66 N = 2 ^ (ceil (log (r_x + l_b - 1) / log (2)));
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
67 B = fft (b, N);
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
68 y = ifft (fft (x, N) .* B(:,ones (1, c_x)));
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
69 else
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
70 ## Use overlap-add method ...
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3890
diff changeset
71 if (! (isscalar (N)))
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
72 error ("fftfilt: N has to be a scalar");
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
73 endif
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
74 N = 2 ^ (ceil (log (max ([N, l_b])) / log (2)));
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
75 L = N - l_b + 1;
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
76 B = fft (b, N);
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
77 B = B(:,ones (c_x,1));
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
78 R = ceil (r_x / L);
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
79 y = zeros (r_x, c_x);
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
80 for r = 1:R;
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
81 lo = (r - 1) * L + 1;
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
82 hi = min (r * L, r_x);
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
83 tmp = zeros (N, c_x);
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
84 tmp(1:(hi-lo+1),:) = x(lo:hi,:);
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
85 tmp = ifft (fft (tmp) .* B);
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
86 hi = min (lo+N-1, r_x);
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
87 y(lo:hi,:) = y(lo:hi,:) + tmp(1:(hi-lo+1),:);
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
88 endfor
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
89 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
90
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
91 y = y(1:r_x,:);
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
92 if (transpose)
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
93 y = y.';
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
94 endif
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
95
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3449
diff changeset
96 ## Final cleanups: if both x and b are real respectively integer, y
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
97 ## should also be
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
98
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
99 if (isreal (b) && isreal (x))
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
100 y = real (y);
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
101 endif
3890
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
102 if (! any (b - round (b)))
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
103 idx = !any (x - round (x));
9652abf2c297 [project @ 2002-04-04 23:24:39 by jwe]
jwe
parents: 3457
diff changeset
104 y(:,idx) = round (y(:,idx));
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
105 endif
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
106
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
107 endfunction