Difference between revisions of "Component: Standard Deviation (Storage)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(One intermediate revision 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
 
| MatrixTSL
 
| MatrixTSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Storage
 
| Storage
 
|}
 
|}
  
  
−
 
+
==Standard Deviation component==
−
==[[File:Component Icon e4dbf608_6521_4e08_a1f5_46b012fc8cc1.png|Image]] Standard Deviation component==
 
 
A set of functions used to calculate the mean and standard deviation on a set of data samples.
 
A set of functions used to calculate the mean and standard deviation on a set of data samples.
  
−
==Examples==
+
==Component Pack==
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
FREE
  
−
==Downloadable macro reference==
+
==Detailed description==
  
−
===<span style="font-weight: normal;"><u><tt>InitialiseFIFO</tt></u></span>===
 
−
initialises the first in first out buffer values to 0
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
''No detailed description exists yet for this component''
  
 +
==Examples==
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>AddSample</tt></u></span>===
+
''<span style="color:red;">No additional examples</span>''
−
Adds a sample to the first in first out sample buffer.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|FLOAT]] ''Sample''
+
==Downloadable macro reference==
−
::Value to add into the FIFO buffer
 
  
 +
{| 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;" | '''InitialiseFIFO'''
 +
|-
 +
| colspan="2" | initialises the first in first out buffer values to 0&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''
 +
|}
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
{| 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;" | '''AddSample'''
 +
|-
 +
| colspan="2" | Adds a sample to the first in first out sample buffer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Sample
 +
|-
 +
| colspan="2" | Value to add into the FIFO 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''
 +
|}
  
  
−
===<span style="font-weight: normal;"><u><tt>GetDeviation</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Gets the standard deviation of the values in the first in first out buffer
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetMean'''
 +
|-
 +
| colspan="2" | Gets the mean of the values in the first in first out buffer&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
{| 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;" | '''GetDeviation'''
 +
|-
 +
| colspan="2" | Gets the standard deviation of the values in the first in first out buffer&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
'''Return value'''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
:[[Variable Types|FLOAT]]
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetSampleCount'''
−
 
+
|-
−
===<span style="font-weight: normal;"><u><tt>GetMean</tt></u></span>===
+
| colspan="2" | Sets the number of samples when using the variable sample count type.&nbsp;
−
Gets the mean of the values in the first in first out buffer
+
|-
−
 
+
|-
−
'''Parameters'''
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
−
 
+
| width="90%" | SampleCount
−
:''This macro has no parameters''
+
|-
 +
| 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''
 +
|}
  
  
−
'''Return value'''
 
−
 
−
:[[Variable Types|FLOAT]]
 
−
 
−
 
−
===<span style="font-weight: normal;"><u><tt>SetSampleCount</tt></u></span>===
 
−
Sets the number of samples when using the variable sample count type.
 
−
 
−
'''Parameters'''
 
−
 
−
:[[Variable Types|UINT]] ''SampleCount''
 
−
 
−
 
−
'''Return value'''
 
−
 
−
:''This call does not return a value''
 
−
 
−
 
−
 
−
==Simulation macro reference==
 
−
 
−
''This component does not contain any simulation macros''
 
  
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Sample Count Type</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''SampCountType''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Controls if the number of samples to determine the mean and deviation are fixed or variable,
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
Fixed has some additional optimisations when adding samples but variable allows flexibility.
+
|-
−
 
+
|-
−
The sample count for variable samples defaults to the max count and can be set using the SetSampleCount macro.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Sample Count Type
−
<span style="font-weight: normal;"><u>Number of Samples</u></span>
+
|-
−
 
+
| colspan="2" | Controls if the number of samples to determine the mean and deviation are fixed or variable, Fixed has some additional optimisations when adding samples but variable allows flexibility. The sample count for variable samples defaults to the max count and can be set using the SetSampleCount macro.&nbsp;
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''NumSamples''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
Fixed number of samples used to calculate the mean and deviation.
+
| width="90%" | Number of Samples
−
 
+
|-
−
Samples are first in first out so the newest sample will replace the oldest.
+
| colspan="2" | Fixed number of samples used to calculate the mean and deviation. Samples are first in first out so the newest sample will replace the oldest.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Initial Sample Value</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Initial Sample Value
−
This property is of type ''Floating point'' and can be referenced with the variable name ''InitialSampleValue''.
+
|-
−
 
+
| colspan="2" | Sets the initial value of each sample when initialising the FIFO.&nbsp;
−
Sets the initial value of each sample when initialising the FIFO.
+
|}

Latest revision as of 17:24, 9 November 2022

Author MatrixTSL
Version 1.0
Category Storage


Standard Deviation component

A set of functions used to calculate the mean and standard deviation on a set of data samples.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png InitialiseFIFO
initialises the first in first out buffer values to 0 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png AddSample
Adds a sample to the first in first out sample buffer. 
Fc9-f32-icon.png - FLOAT Sample
Value to add into the FIFO buffer 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetMean
Gets the mean of the values in the first in first out buffer 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png GetDeviation
Gets the standard deviation of the values in the first in first out buffer 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png SetSampleCount
Sets the number of samples when using the variable sample count type. 
Fc9-u16-icon.png - UINT SampleCount
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Sample Count Type
Controls if the number of samples to determine the mean and deviation are fixed or variable, Fixed has some additional optimisations when adding samples but variable allows flexibility. The sample count for variable samples defaults to the max count and can be set using the SetSampleCount macro. 
Fc9-type-21-icon.png Number of Samples
Fixed number of samples used to calculate the mean and deviation. Samples are first in first out so the newest sample will replace the oldest. 
Fc9-type-15-icon.png Initial Sample Value
Sets the initial value of each sample when initialising the FIFO. 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Standard_Deviation_(Storage)&oldid=28888"