Difference between revisions of "Component: Standard Deviation (Calculation)"
From Flowcode Help
Jump to navigationJump to search| (2 intermediate revisions by the same user not shown) | |||
| Line 57: | Line 57: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 65: | Line 71: | ||
==Macro reference== | ==Macro reference== | ||
| − | === | + | ===AddSample=== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddSample''' |
| + | |- | ||
| + | | colspan="2" | Adds a sample to the first in first out sample buffer. | ||
| + | |- | ||
|- | |- | ||
| − | | | + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT |
| + | | width="90%" | Sample | ||
|- | |- | ||
| + | | colspan="2" | Value to add into the FIFO buffer | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| Line 79: | Line 90: | ||
| − | === | + | ===GetDeviation=== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDeviation''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Gets the standard deviation of the values in the first in first out buffer |
|- | |- | ||
|- | |- | ||
| − | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| Line 112: | Line 118: | ||
| − | === | + | ===InitialiseFIFO=== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''InitialiseFIFO''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | initialises the first in first out buffer values to 0 |
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | + | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| Line 143: | Line 149: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| − | |||
| − | |||
Latest revision as of 13:12, 7 February 2023
| Author | MatrixTSL |
| Version | 1.0 |
| Category | Calculation |
Contents
Standard Deviation component
A set of functions used to calculate the mean and standard deviation on a set of data samples.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_StandardDeviation.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_StandardDeviation.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
AddSample
|
AddSample |
| Adds a sample to the first in first out sample buffer. | |
 - FLOAT
|
Sample |
| Value to add into the FIFO buffer | |
 - VOID
|
Return |
GetDeviation
|
|
GetDeviation |
| Gets the standard deviation of the values in the first in first out buffer | |
| - FLOAT
|
Return |
GetMean
|
|
GetMean |
| Gets the mean of the values in the first in first out buffer | |
| - FLOAT
|
Return |
InitialiseFIFO
|
|
InitialiseFIFO |
| initialises the first in first out buffer values to 0 | |
| - VOID
|
Return |
SetSampleCount
|
|
SetSampleCount |
| Sets the number of samples when using the variable sample count type. | |
 - UINT
|
SampleCount |
| - VOID
|
Return |
Property reference
|
Properties |
|
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. | |
|
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. | |
|
Initial Sample Value |
| Sets the initial value of each sample when initialising the FIFO. | |
