Difference between revisions of "Component: Filter (DSP)"
(XML import of component documentation) |
(XML import of components for release) |
||
| Line 16: | Line 16: | ||
==[[File:Component Icon 317efb6a_2bad_4f83_a0bc_4ada0f4cd51e.png|Image]] Filter component== | ==[[File:Component Icon 317efb6a_2bad_4f83_a0bc_4ada0f4cd51e.png|Image]] Filter component== | ||
| − | + | Filter component to allow basic filtering to be performed | |
==Examples== | ==Examples== | ||
| Line 25: | Line 25: | ||
===<span style="font-weight: normal;"><u><tt>Filter</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>Filter</tt></u></span>=== | ||
| − | + | Performs the filter operation to the contents of the entire buffer in one go. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| Line 40: | Line 38: | ||
===<span style="font-weight: normal;"><u><tt>FilterTick</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>FilterTick</tt></u></span>=== | ||
| − | + | Performs the filter operation to the current value in the buffer. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| Line 65: | Line 61: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''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 | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Input</u></span> | <span style="font-weight: normal;"><u>Input</u></span> | ||
| Line 73: | Line 67: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''input_a''. | 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 | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Output</u></span> | <span style="font-weight: normal;"><u>Output</u></span> | ||
| Line 81: | Line 73: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''output_c''. | 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 | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Type</u></span> | <span style="font-weight: normal;"><u>Type</u></span> | ||
| Line 89: | Line 79: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''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 | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Coefficient 0</u></span> | <span style="font-weight: normal;"><u>Coefficient 0</u></span> | ||
| Line 105: | Line 93: | ||
This property is of type ''Floating point'' and can be referenced with the variable name ''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 | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Nyquist Frequency</u></span> | <span style="font-weight: normal;"><u>Nyquist Frequency</u></span> | ||
| Line 113: | Line 99: | ||
This property is of type ''Floating point'' and can be referenced with the variable name ''nyquist''. | 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 | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Cutt Off Frequency 0</u></span> | <span style="font-weight: normal;"><u>Cutt Off Frequency 0</u></span> | ||
| Line 121: | Line 105: | ||
This property is of type ''Floating point'' and can be referenced with the variable name ''cut_off_0''. | This property is of type ''Floating point'' and can be referenced with the variable name ''cut_off_0''. | ||
| − | + | First cutoff frequency | |
Revision as of 13:34, 2 September 2013
| Author | Matrix Ltd |
| Version | 1.2 |
| Category | DSP |
Contents
Filter component
Filter component to allow basic filtering to be performed
Examples
No additional examples
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
