Programmer Guide/Command Reference/EVAL/iir1: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:iir1, iir2}}
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
Initialize and/or apply an IIR filter.
{{EVALFunctionTemplate}}
Create and/or apply an IIR filter.
----
----
;Usage 1: <code>iir1(<var>f1</var>, <var>f2</var>  {, <var>m</var>, <var>rp</var>, <var>rs</var>, <var>inv</var>, <var>type</var>})</code>
;Usage 1: <code>iir1(<var>f1</var>, <var>f2</var>  {, <var>m</var>, <var>rp</var>, <var>rs</var>, <var>inv</var>, <var>type</var>})</code>
:;<var>f1, f2</var>: the lower and upper cutoff frequency; both values must be specified as ''relative frequencies'' (f / sampling-rate); 0 <= ''f1'' < ''f2'' <= 0.5
:;<var>f1, f2</var>: the lower and upper cutoff frequency; both values must be specified as ''relative frequencies'' (f / sampling-rate); 0 &le; ''f1'' < ''f2'' &le; 0.5
;<var>m</var>: the filter order (default=5)
;<var>m</var>: the filter order (default=5)
;<var>rp</var>: the desired passband ripple in dB; 0 < ''rp'' (default=0.5)
;<var>rp</var>: the desired passband ripple in dB; 0 < ''rp'' (default=0.5)
Line 9: Line 10:
;<var>inv</var>: invert filter response (0=no, 1=yes); if this value is set to 1, the filter frequency response is inverted and f1/f2 are the boundaries of the stopband
;<var>inv</var>: invert filter response (0=no, 1=yes); if this value is set to 1, the filter frequency response is inverted and f1/f2 are the boundaries of the stopband
<var>type</var>: the type of the filter
<var>type</var>: the type of the filter
::{class=keinrahmen"
::{|class="keinrahmen"
|''type''=1 ||... Butterworth filter
|''type''=1 ||... Butterworth filter
|''type''=2 ||... Chebyshev filter
|''type''=2 ||... Chebyshev filter
|''type''=3 ||... elliptic filter (this is the default)
|''type''=3 ||... elliptic filter (this is the default)
;Result: The function computes the filter coefficients for the IIR defined by the arguments and returns a matrix ''c'' with 2 columns. The first column (''c''[*,0]) contains the denominator coefficients (poles) and the second (''c''[*,1]) the nominator coefficients (zeros). The matrix ''c'' can be used to apply the filter to a signal (see '''Usage 3''').
|}
;Result 1: The function computes the filter coefficients for the IIR defined by the arguments and returns a matrix ''c'' with 2 columns. The first column (''c''[*,0]) contains the denominator coefficients (poles) and the second (''c''[*,1]) the nominator coefficients (zeros). The matrix ''c'' can be used to apply the filter to a signal (see '''Usage 3''').
----
----
;Usage 2: <code>iir1(<var>f1</var>, <var>f2</var>, <var>m</var>, <var>rp</var>, <var>rs</var>, <var>inv</var>, <var>type</var>, <var>x</var>)</code>
;Usage 2: <code>iir1(<var>f1</var>, <var>f2</var>, <var>m</var>, <var>rp</var>, <var>rs</var>, <var>inv</var>, <var>type</var>, <var>x</var>)</code>
:;<var>f1, f2, m, rp, rs, inv, type</var>: see Usage 1
:;<var>f1, f2, m, rp, rs, inv, type</var>: see '''Usage 1'''
:;<var>x</var>: a vector containing the source signal
:;<var>x</var>: a vector containing the source signal
;Result: The function computes the filter coefficients for the IIR defined by the arguments and applies it to the signal ''x''. The result has the same type as the input signal ''x'' and containes the filtered signal.
;Result 2: The function computes the filter coefficients for the IIR defined by the arguments and applies it to the signal ''x''. The result has the same type as the input signal ''x'' and containes the filtered signal.
----
----
:Usage 3: <code>iir1(<var>c</var>, <var>z</sub>, <var>x</sub>{, <var>s</var>})
;Usage 3: <code>iir1(<var>c</var>, <var>z</var>, <var>x</var> {, <var>s</var>})</code>
:;<var>c</var>: IIR filter coefficients (see '''Usage 1''')
:;<var>c</var>: IIR filter coefficients (see '''Usage 1''')
:;<var>z</var>: the filter state (delay); must be a matrix with the same dimensions as ''c''
:;<var>z</var>: the filter state (delay); must be a matrix with the same dimensions as ''c''
:note: The matrix should be initialized with zeros (e.g.: <code>#z := eval init($#c[!nrow],$#c[!ncol],0)</code>)
::notes:
::*The matrix should be initialized with zeros (e.g.: <code>#z := eval init($#c[!nrow],$#c[!ncol],0)</code>)
::*The values of ''z'' are changed (''z'' must be a ''reference'' to a [[Programmer_Guide/Shell_Items/Table|table item]])
:;<var>x</var>: the signal sample (scalar) or the signal vector to be filtered
:;<var>x</var>: the signal sample (scalar) or the signal vector to be filtered
:;<var>s</var>: the downsampling factor; must be an integer in the range <code>0<''s''<ncol(''x'')</code> (default=1)
::note:
::*If ''s''>1, only the filter output values y[0], y[''s''], y[2''s''], ... are stored in the result.
::*If ''s''>1, <code>nrow(''x'')</code> should be a multiple of ''s''.
:;
:;
;Result 3: The filtered signal (sample or vector). The argument (reference) ''z'' is updated with the new filter state.
----
;See also: [[../fir1|fir1]]


;See also:
[[../#Functions|<function list>]]

Latest revision as of 14:28, 2 March 2015

Create and/or apply an IIR filter.


Usage 1
iir1(f1, f2 {, m, rp, rs, inv, type})
f1, f2
the lower and upper cutoff frequency; both values must be specified as relative frequencies (f / sampling-rate); 0 ≤ f1 < f2 ≤ 0.5
m
the filter order (default=5)
rp
the desired passband ripple in dB; 0 < rp (default=0.5)
rs
the desired stopband damping level in dB; 0 < rs (default=40)
inv
invert filter response (0=no, 1=yes); if this value is set to 1, the filter frequency response is inverted and f1/f2 are the boundaries of the stopband

type: the type of the filter

type=1 ... Butterworth filter type=2 ... Chebyshev filter type=3 ... elliptic filter (this is the default)
Result 1
The function computes the filter coefficients for the IIR defined by the arguments and returns a matrix c with 2 columns. The first column (c[*,0]) contains the denominator coefficients (poles) and the second (c[*,1]) the nominator coefficients (zeros). The matrix c can be used to apply the filter to a signal (see Usage 3).

Usage 2
iir1(f1, f2, m, rp, rs, inv, type, x)
f1, f2, m, rp, rs, inv, type
see Usage 1
x
a vector containing the source signal
Result 2
The function computes the filter coefficients for the IIR defined by the arguments and applies it to the signal x. The result has the same type as the input signal x and containes the filtered signal.

Usage 3
iir1(c, z, x {, s})
c
IIR filter coefficients (see Usage 1)
z
the filter state (delay); must be a matrix with the same dimensions as c
notes:
  • The matrix should be initialized with zeros (e.g.: #z := eval init($#c[!nrow],$#c[!ncol],0))
  • The values of z are changed (z must be a reference to a table item)
x
the signal sample (scalar) or the signal vector to be filtered
s
the downsampling factor; must be an integer in the range 0<s<ncol(x) (default=1)
note:
  • If s>1, only the filter output values y[0], y[s], y[2s], ... are stored in the result.
  • If s>1, nrow(x) should be a multiple of s.
Result 3
The filtered signal (sample or vector). The argument (reference) z is updated with the new filter state.

See also
fir1

<function list>

Navigation menu

Personal tools