Programmer Guide/Command Reference/EVAL/iir1 - Revision history

Jw at 13:28, 2 March 2015

2015-03-02T13:28:20Z

← Older revision		Revision as of 15:28, 2 March 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{EVALFunctionTemplate}}
	Create and/or apply an IIR filter.		Create and/or apply an IIR filter.
	----		----

Christian at 18:19, 21 April 2011

2011-04-21T18:19:40Z

← Older revision		Revision as of 20:19, 21 April 2011
Line 3:		Line 3:
	----		----
	;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 ≤ ''f1'' < ''f2'' ≤ 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)

193.171.195.48 at 09:57, 21 April 2011

2011-04-21T09:57:39Z

← Older revision		Revision as of 11:57, 21 April 2011
Line 14:		Line 14:
	\|''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</var>, <var>x</var> {, <var>s</var>})</code>		;Usage 3: <code>iir1(<var>c</var>, <var>z</var>, <var>x</var> {, <var>s</var>})</code>
Line 33:		Line 33:
	::*If ''s''>1, <code>nrow(''x'')</code> should be a multiple of ''s''.		::*If ''s''>1, <code>nrow(''x'')</code> should be a multiple of ''s''.
	:;		:;
	;Result: The filtered signal (sample or vector). The argument (reference) ''z'' is updated with the new filter state.		;Result 3: The filtered signal (sample or vector). The argument (reference) ''z'' is updated with the new filter state.
	----		----
	;See also: [[~~Programmer_Guide/Command_Reference/EVAL~~/fir1\|fir1]]		;See also: [[../fir1\|fir1]]

	[[~~Programmer_Guide~~/~~Command_Reference/EVAL~~#Functions\|<function list>]]		[[../#Functions\|<function list>]]

Toni at 12:31, 11 April 2011

2011-04-11T12:31:26Z

← Older revision		Revision as of 14:31, 11 April 2011
Line 17:		Line 17:
	----		----
	;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: 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>})</code>		;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''
	::notes:		::notes:
	::*The matrix should be initialized with zeros (e.g.: <code>#z := eval init($#c[!nrow],$#c[!ncol],0)</code>)		::*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]]		::*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)		:;<var>s</var>: the downsampling factor; must be an integer in the range <code>0<''s''<ncol(''x'')</code> (default=1)

Toni at 12:07, 11 April 2011

2011-04-11T12:07:50Z

← Older revision		Revision as of 14:07, 11 April 2011
Line 34:		Line 34:
	:;		:;
	;Result: The filtered signal (sample or vector). The argument (reference) ''z'' is updated with the new filter state.		;Result: The filtered signal (sample or vector). The argument (reference) ''z'' is updated with the new filter state.
			----
	;See also: [[Programmer_Guide/Command_Reference/EVAL/fir1\|fir1]]		;See also: [[Programmer_Guide/Command_Reference/EVAL/fir1\|fir1]]

	[[Programmer_Guide/Command_Reference/EVAL#Functions\|<function list>]]		[[Programmer_Guide/Command_Reference/EVAL#Functions\|<function list>]]

Toni at 12:07, 11 April 2011

2011-04-11T12:07:10Z

← Older revision		Revision as of 14:07, 11 April 2011
Line 9:		Line 9:
	;<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: 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''').
	----		----

Toni at 12:06, 11 April 2011

2011-04-11T12:06:43Z

← Older revision		Revision as of 14:06, 11 April 2011
Line 20:		Line 20:
	;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: 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</sub>, <var>x</sub>{, <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''
Line 27:		Line 27:
	::*The values of ''z'' are changed (''z'' must be a ''reference'' to a [[Programmer_Guide/Shell_Items/Table\|table item]]		::*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: The filtered signal (sample or vector). The argument (reference) ''z'' is updated with the new filter state.

	;See also: [[Programmer_Guide/Command_Reference/EVAL/fir1\|fir1]]		;See also: [[Programmer_Guide/Command_Reference/EVAL/fir1\|fir1]]

	[[Programmer_Guide/Command_Reference/EVAL#Functions\|<function list>]]		[[Programmer_Guide/Command_Reference/EVAL#Functions\|<function list>]]

Toni at 11:55, 11 April 2011

2011-04-11T11:55:23Z

← Older revision		Revision as of 13:55, 11 April 2011
Line 1:		Line 1:
	{{DISPLAYTITLE:~~iir1, iir2~~}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	~~Initialize~~ and/or apply an IIR filter.		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>
Line 23:		Line 23:
	:;<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
	:;		:;

	;See also:		;See also: [[Programmer_Guide/Command_Reference/EVAL/fir1\|fir1]]

			[[Programmer_Guide/Command_Reference/EVAL#Functions\|<function list>]]

Toni at 11:47, 11 April 2011

2011-04-11T11:47:52Z

@@ Line 1: / Line 1: @@
-{{DISPLAYTITLE:{{SUBPAGENAME}}}}
+{{DISPLAYTITLE:iir1, iir2}}
-=====iir1=====
+Initialize and/or apply an IIR filter.
-An Infinite Impulse Response (IIR) filter.
+;See also:

Admin: 1 revision: Initial import

2010-11-18T16:31:41Z

1 revision: Initial import

← Older revision	Revision as of 18:31, 18 November 2010
(No difference)