[931198]: fourier / firfilter.m Maximize Restore History

Download this file

firfilter.m    94 lines (80 with data), 2.9 kB

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
function gout=firfilter(name,M,varargin)
%FIRFILTER Construct an FIR filter
% Usage: g=firfilter(name,M);
% g=firfilter(name,M,...);
%
% `firfilter(name,M)` creates an FIR filter of length *M*. This is
% exactly the same as calling |firwin|. The name must be one of the
% accepted window types of |firwin|.
%
% `firfilter(name,M,centre)` constructs a filter with a centre
% frequency of *centre* measured in normalized frequencies.
%
% If one of the inputs is a vector, the output will be a cell array
% with one entry in the cell array for each element in the vector. If
% more input are vectors, they must have the same size and shape and the
% the filters will be generated by stepping through the vectors. This
% is a quick way to create filters for |filterbank| and |ufilterbank|.
%
% `firfilter` accepts the following optional parameters:
%
% 'fs',fs If the sampling frequency *fs* is specified then the length
% *M* is specified in seconds and the centre frequency
% *centre* in Hz.
%
% 'complex' Make the filter complex valued if the centre frequency
% is non-zero. This is the default.
%
% 'real' Make the filter real-valued if the centre frequency
% is non-zero.
%
% 'delay',d Set the delay of the filter. Default value is zero.
%
% 'causal' Create a causal filter starting at the first sample. If
% specified, this flag overwrites the delay setting.
%
% It is possible to normalize the impulse response of the filter by
% passing any of the flags from the |normalize| function. The default
% normalization is `'area'`, ensuring that the filter has 0dB
% attenuation at its centre frequency.
%
% The filter can be used in the |pfilt| routine to filter a signal, or
% in can be placed in a cell-array for use with |filterbank| or |ufilterbank|.
%
% See also: blfilter, firwin, pfilt, filterbank
% XXX Implement passing additional parameters to firwin
% Define initial value for flags and key/value pairs.
definput.import={'normalize'};
definput.importdefaults={'area'};
definput.keyvals.delay=0;
definput.keyvals.centre=0;
definput.keyvals.fs=[];
definput.flags.delay={'delay','causal'};
definput.flags.real={'complex','real'};
[flags,kv]=ltfatarghelper({'centre'},definput,varargin);
[M,kv.centre,kv.delay]=scalardistribute(M,kv.centre,kv.delay);
if ~isempty(kv.fs)
M=round(M*kv.fs);
kv.centre=kv.centre/kv.fs*2;
end;
if flags.do_causal
g.offset=0;
smallshift=0;
else
d=floor(kv.delay);
smallshift=d-floor(d);
g.offset=d-floor(M/2);
end;
Nfilt=numel(M);
gout=cell(1,Nfilt);
for ii=1:Nfilt
g=struct();
g.h=fftshift(firwin(name,M(ii),'shift',smallshift(ii),flags.norm));
g.centre=kv.centre(ii);
g.realonly=flags.do_real;
g.fs=kv.fs;
gout{ii}=g;
end;
if Nfilt==1
gout=g;
end;