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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.2 (Release)
+
| 1.2
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| DSP
 
| DSP
 
|}
 
|}
  
  
−
 
+
==Median component==
−
==[[File:Component Icon facc8c89_963a_408e_985e_ed768a52b01a.png|Image]] Median component==
 
 
Collects the median value removing any potential high frequency spikes in the data.
 
Collects the median value removing any potential high frequency spikes in the data.
  
−
==Examples==
+
==Component Pack==
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
DSP
  
−
==Downloadable macro reference==
+
==Detailed description==
  
−
===<span style="font-weight: normal;"><u><tt>MedianArray</tt></u></span>===
 
−
Passes an entire buffer through the median buffer and spits out a filtered version of the data at the other end
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Median</tt></u></span>===
 
−
Passes a single value from a DSP buffer into the median buffer and spits out a median value at the other end
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
 +
''No detailed description exists yet for this component''
  
−
'''Return value'''
+
==Examples==
  
−
:''This call does not return a value''
 
  
  
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
 
  
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>Connect To</u></span>
 
  
−
This property is of type ''Panel object'' and can be referenced with the variable name ''ConnectTo''.
 
  
−
DSP component with output buffer to collect our data from.
 
  
−
<span style="font-weight: normal;"><u>Buffer Size</u></span>
 
  
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''BuffSize''.
 
  
−
Number of individual elements the buffer can store, default 1.
+
''<span style="color:red;">No additional examples</span>''
  
−
<span style="font-weight: normal;"><u>Buffer Type</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''BuffType''.
+
==Downloadable macro reference==
  
−
Sets the buffer data type.
+
{| 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;" | '''MedianArray'''
 +
|-
 +
| colspan="2" | Passes an entire buffer through the median buffer and spits out a filtered version of the data at the other end&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''
 +
|}
  
−
<span style="font-weight: normal;"><u>Median Buffer Size</u></span>
 
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''MedBuffSize''.
+
{| 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;" | '''Median'''
 +
|-
 +
| colspan="2" | Passes a single value from a DSP buffer into the median buffer and spits out a median value at the other end&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''
 +
|}
  
−
The number of values to buffer to create the median effect. Default 5.
 
  
−
The higher the number the more immune to spikes the data will be.
 
  
−
A larger buffer requires more processing to order.
 
  
−
Minimum 3, maximum 255.
+
==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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Median Array
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Median Array Size
 +
|-
 +
| colspan="2" | The number of values to combine together to create the median effect. Default 5. The higher the number the more immune to spikes the data will be. A larger array requires more processing to order. Minimum 3, maximum 255.&nbsp;
 +
|}

Latest revision as of 17:19, 9 November 2022

Author Matrix Ltd
Version 1.2
Category DSP


Median component

Collects the median value removing any potential high frequency spikes in the data.

Component Pack

DSP

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png MedianArray
Passes an entire buffer through the median buffer and spits out a filtered version of the data at the other end 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Median
Passes a single value from a DSP buffer into the median buffer and spits out a median value at the other end 
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-conn-icon.png Median Array
Fc9-type-14-icon.png Median Array Size
The number of values to combine together to create the median effect. Default 5. The higher the number the more immune to spikes the data will be. A larger array requires more processing to order. Minimum 3, maximum 255. 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Median_(DSP)&oldid=28539"