Difference between revisions of "Component: Filter (DSP)"

From Flowcode Help
Jump to navigationJump to search
(XML import of component help)
Line 20: Line 20:
  
 
==Examples==
 
==Examples==
''<span style="color:red;">No additional examples</span>''
 
  
 +
 +
Example of the filter component set up to create a low pass filter.
 +
 +
[[File:LowPassFilter.fcfx]]
 +
 +
 +
Low pass filter running at a low frequency
 +
 +
[[File:LPFilter.jpg]]
 +
 +
 +
 +
Low pass filter running at a high frequency
 +
 +
[[File:LPFilter2.jpg]]
  
 
==Downloadable macro reference==
 
==Downloadable macro reference==

Revision as of 16:15, 19 November 2013


Author Matrix Ltd
Version 1.2
Category DSP


Image Filter component

Filter component to allow basic filtering to be performed Filters include: LowPass, HighPass, BandPass, BandStop, FIR, IIR

Examples

Example of the filter component set up to create a low pass filter.

File:LowPassFilter.fcfx


Low pass filter running at a low frequency

LPFilter.jpg


Low pass filter running at a high frequency

LPFilter2.jpg

Downloadable macro reference

Filter

Performs the filter operation to the contents of the entire buffer in one go.

Parameters

This macro has no parameters


Return value

This call does not return a value


FilterTick

Performs the filter operation to the current value in the buffer.

Parameters

This macro has no parameters


Return value

This call does not return a value


Simulation macro reference

This component does not contain any simulation macros


Property reference

Buffer Manager

This property is of type Fixed list of ints and can be referenced with the variable name buffer_manager.

Determines which buffer manager component to refer to

Input

This property is of type Fixed list of ints and can be referenced with the variable name input_a.

Specifies the input buffer which will pass values into the filter

Output

This property is of type Fixed list of ints and can be referenced with the variable name output_c.

Specifies the output buffer which will store values from the filter

Type

This property is of type Fixed list of ints and can be referenced with the variable name type.

Specifies the filter type created by the component

Coefficient 0

This property is of type Signed integer and can be referenced with the variable name coef0.

No additional information


Sample Rate

This property is of type Floating point and can be referenced with the variable name sample_rate.

Sample frequency used to work out some basic useful calculations

Nyquist Frequency

This property is of type Floating point and can be referenced with the variable name nyquist.

Maximum theoretical frequency that can be obtained by the sample frequency

Cutt Off Frequency 0

This property is of type Floating point and can be referenced with the variable name cut_off_0.

First cutoff frequency