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

From Flowcode Help
Jump to navigationJump to search
Line 22: Line 22:
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 68: Line 70:
  
  
−
''<span style="color:red;">No additional examples</span>''
 
  
  
−
==Macro reference==
+
''<span style="color:red;">No additional examples</span>''
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Filter'''
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FilterArray'''
 
−
|-
 
−
| colspan="2" | Performs the filter on every element inside the buffer.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
−
 
+
==Macro reference==
−
 
 
−
 
 
−
==Property reference==
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Connect To
 
−
|-
 
−
| colspan="2" | DSP component with output buffer to collect our data from.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
−
| width="90%" | Buffer Size
 
−
|-
 
−
| colspan="2" | Number of individual elements the buffer can store, default 1.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Buffer Type
 
−
|-
 
−
| colspan="2" | Sets the buffer data type.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Direction
 
−
|-
 
−
| colspan="2" | Sets the data direction flow of the component&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Filter Properties
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
−
| width="90%" | Process Noise (Q)
 
−
|-
 
−
| colspan="2" | Process noise covariance. Range 0.0 to 1.0&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
−
| width="90%" | Sensor Noise (R)
 
−
|-
 
−
| colspan="2" | Sensor noise covariance. Range 0.0 to 1.0&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Maintain Stats
 
−
|-
 
−
| colspan="2" | Maintains the raw error and the kalman error to give an indication of the effectiveness of the filter. Must be set to Yes to allow the GetErrorStat macro to function.&nbsp;
 
−
|}==Macro reference==
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Filter'''
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FilterArray'''
 
−
|-
 
−
| colspan="2" | Performs the filter on every element inside the buffer.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
 
−
 
 
−
 
 
−
 
 
−
==Property reference==
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Connect To
 
−
|-
 
−
| colspan="2" | DSP component with output buffer to collect our data from.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
−
| width="90%" | Buffer Size
 
−
|-
 
−
| colspan="2" | Number of individual elements the buffer can store, default 1.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Buffer Type
 
−
|-
 
−
| colspan="2" | Sets the buffer data type.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Direction
 
−
|-
 
−
| colspan="2" | Sets the data direction flow of the component&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Filter Properties
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
−
| width="90%" | Process Noise (Q)
 
−
|-
 
−
| colspan="2" | Process noise covariance. Range 0.0 to 1.0&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
−
| width="90%" | Sensor Noise (R)
 
−
|-
 
−
| colspan="2" | Sensor noise covariance. Range 0.0 to 1.0&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Maintain Stats
 
−
|-
 
−
| colspan="2" | Maintains the raw error and the kalman error to give an indication of the effectiveness of the filter. Must be set to Yes to allow the GetErrorStat macro to function.&nbsp;
 
−
|}==Macro reference==
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Filter'''
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FilterArray'''
 
−
|-
 
−
| colspan="2" | Performs the filter on every element inside the buffer.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
 
−
 
 
−
 
 
−
 
 
−
==Property reference==
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Connect To
 
−
|-
 
−
| colspan="2" | DSP component with output buffer to collect our data from.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
−
| width="90%" | Buffer Size
 
−
|-
 
−
| colspan="2" | Number of individual elements the buffer can store, default 1.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Buffer Type
 
−
|-
 
−
| colspan="2" | Sets the buffer data type.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Direction
 
−
|-
 
−
| colspan="2" | Sets the data direction flow of the component&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Filter Properties
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
−
| width="90%" | Process Noise (Q)
 
−
|-
 
−
| colspan="2" | Process noise covariance. Range 0.0 to 1.0&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
−
| width="90%" | Sensor Noise (R)
 
−
|-
 
−
| colspan="2" | Sensor noise covariance. Range 0.0 to 1.0&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Maintain Stats
 
−
|-
 
−
| colspan="2" | Maintains the raw error and the kalman error to give an indication of the effectiveness of the filter. Must be set to Yes to allow the GetErrorStat macro to function.&nbsp;
 
−
|}==Macro reference==
 
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 16:47, 30 January 2023

Author Matrix Ltd
Version 1.2
Category DSP Operators


Kalman Filter component

Provides a way of intelligently filtering noise from data to allow for better sensor approximations.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_DSP_Kalman.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_DSP_Kalman.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples



Macro reference

Fc9-comp-macro.png Filter
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png FilterArray
Performs the filter on every element inside the buffer. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Connect To
DSP component with output buffer to collect our data from. 
Fc9-type-21-icon.png Buffer Size
Number of individual elements the buffer can store, default 1. 
Fc9-type-16-icon.png Buffer Type
Sets the buffer data type. 
Fc9-type-16-icon.png Direction
Sets the data direction flow of the component 
Fc9-conn-icon.png Filter Properties
Fc9-type-15-icon.png Process Noise (Q)
Process noise covariance. Range 0.0 to 1.0 
Fc9-type-15-icon.png Sensor Noise (R)
Sensor noise covariance. Range 0.0 to 1.0 
Fc9-type-7-icon.png Maintain Stats
Maintains the raw error and the kalman error to give an indication of the effectiveness of the filter. Must be set to Yes to allow the GetErrorStat macro to function. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Kalman_Filter_(DSP_Operators)&oldid=34851"