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

Christian at 18:22, 21 April 2011

2011-04-21T18:22:00Z

← Older revision		Revision as of 20:22, 21 April 2011
Line 3:		Line 3:
	----		----
	;Usage 1: <code>fir1(<var>f1</var>, <var>f2</var> , <var>m</var>)</code>		;Usage 1: <code>fir1(<var>f1</var>, <var>f2</var> , <var>m</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 number of filter taps		;<var>m</var>: the number of filter taps
	;Result: The function computes the FIR coefficients for the filter defined by the arguments and returns a vector ''c'' with 2''m''+1 elements. The result ''c'' can be used to apply the filter to a signal (see '''Usage 3''').		;Result: The function computes the FIR coefficients for the filter defined by the arguments and returns a vector ''c'' with 2''m''+1 elements. The result ''c'' can be used to apply the filter to a signal (see '''Usage 3''').

193.171.195.48 at 09:43, 21 April 2011

2011-04-21T09:43:28Z

← Older revision		Revision as of 11:43, 21 April 2011
Line 26:		Line 26:
	;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~~/iir1\|iir1]]		;See also: [[../iir1\|iir1]]

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

Toni at 12:30, 11 April 2011

2011-04-11T12:30:11Z

@@ Line 8: / Line 8: @@
 ----
 ;Usage 2: <code>fir1(<var>f1</var>, <var>f2</var>, <var>m</var>, <var>x</var>)</code>
-:;<var>f1, f2, m</var>: see Usage 1
+:;<var>f1, f2, m</var>: see '''Usage 1'''
 :;<var>x</var>: a vector containing the source signal
 ;Result: The function computes the filter coefficients for the FIR 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.
@@ Line 17: / Line 17: @@
 ::notes:
 ::*The vector should be initialized with zeros (e.g.: <code>#z := eval fill($#c[!nrow],0,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>s</var>: the downsampling factor; must be an integer in the range <code>0<''s''<ncol(''x'')</code> (default=1)
@@ Line 29: / Line 29: @@
 [[Programmer_Guide/Command_Reference/EVAL#Functions|<function list>]]

Toni at 12:26, 11 April 2011

2011-04-11T12:26:14Z

← Older revision		Revision as of 14:26, 11 April 2011
Line 12:		Line 12:
	;Result: The function computes the filter coefficients for the FIR 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 FIR 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>fir1(<var>c</var>, <var>z</~~sub~~>, <var>x</~~sub~~>{, <var>s</var>})</code>		;Usage 3: <code>fir1(<var>c</var>, <var>z</var>, <var>x</var>{, <var>s</var>})</code>
	:;<var>c</var>: FIR filter coefficients (see '''Usage 1''')		:;<var>c</var>: FIR filter coefficients (see '''Usage 1''')
	:;<var>z</var>: the filter state (delay); must be a vector with the same length as ''c''		:;<var>z</var>: the filter state (delay); must be a vector with the same length as ''c''

Toni at 12:25, 11 April 2011

2011-04-11T12:25:26Z

← Older revision		Revision as of 14:25, 11 April 2011
Line 1:		Line 1:
			{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			Create and/or apply a FIR filter.
			----
			;Usage 1: <code>fir1(<var>f1</var>, <var>f2</var> , <var>m</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>m</var>: the number of filter taps
			;Result: The function computes the FIR coefficients for the filter defined by the arguments and returns a vector ''c'' with 2''m''+1 elements. The result ''c'' can be used to apply the filter to a signal (see '''Usage 3''').
			----
			;Usage 2: <code>fir1(<var>f1</var>, <var>f2</var>, <var>m</var>, <var>x</var>)</code>
			:;<var>f1, f2, m</var>: see Usage 1
			:;<var>x</var>: a vector containing the source signal
			;Result: The function computes the filter coefficients for the FIR 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>fir1(<var>c</var>, <var>z</sub>, <var>x</sub>{, <var>s</var>})</code>
			:;<var>c</var>: FIR filter coefficients (see '''Usage 1''')
			:;<var>z</var>: the filter state (delay); must be a vector with the same length as ''c''
			::notes:
			::*The vector should be initialized with zeros (e.g.: <code>#z := eval fill($#c[!nrow],0,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>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/iir1\|iir1]]

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



	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	=====fir1=====		=====fir1=====

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)

193.171.195.8: initial import

2010-05-17T13:05:27Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
=====fir1=====

A Finite Impulse Response (FIR) filter.

=====Usage:=====

<code>fir1(<var>f1</var>, <var>f2</var>, <var>n</var>)</code>

=====Function:=====

Computes the filter coefficients for a FIR filter with cutoff frequencies <var>f1</var>, <var>f2</var> and the length <code>2*</code><var>n</var><code>+1</code>.

=====Result:=====

A vector with <code>2*</code><var>n</var><code>+1</code> filter coefficients.

=====Usage:=====

<code>fir1(<var>f1</var>, <var>f2</var>, <var>n</var>, <var>x</var>)</code>

=====Function:=====

Computes the filter coefficients for a FIR filter with cutoff frequencies <var>f1</var>, <var>f2</var> and the length <code>2*</code><var>n</var><code>+1</code> and applies the computed filter to the signal vector <var>x</var>.

=====Result:=====

The FIR filtered signal.

=====Return Type:=====

Same as <var>x</var>.