Difference between revisions of "Component: Standard Deviation (Calculation)"
From Flowcode Help
Jump to navigationJump to search| Line 16: | Line 16: | ||
==Component Source Code== | ==Component Source Code== | ||
| + | |||
| + | Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_StandardDeviation.fcfx FC_Comp_Source_StandardDeviation.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_StandardDeviation.fcfx FC_Comp_Source_StandardDeviation.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_StandardDeviation.fcfx FC_Comp_Source_StandardDeviation.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 32: | Line 36: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 46: | Line 52: | ||
==Macro reference== | ==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;" | '''InitialiseFIFO''' | ||
| + | |- | ||
| + | | colspan="2" | initialises the first in first out buffer values to 0 | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''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="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;" | '''GetMean''' | ||
| + | |- | ||
| + | | colspan="2" | Gets the mean 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="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;" | '''GetDeviation''' | ||
| + | |- | ||
| + | | 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="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;" | '''SetSampleCount''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the number of samples when using the variable sample count type. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
| + | | width="90%" | SampleCount | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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%" | Sample Count Type | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Number of Samples | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | ||
| + | | width="90%" | Initial Sample Value | ||
| + | |- | ||
| + | | colspan="2" | Sets the initial value of each sample when initialising the FIFO. | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 15:24, 20 January 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
|
InitialiseFIFO |
| initialises the first in first out buffer values to 0 | |
 - VOID
|
Return |
|
|
AddSample |
| Adds a sample to the first in first out sample buffer. | |
 - FLOAT
|
Sample |
| Value to add into the FIFO buffer | |
| - VOID
|
Return |
|
|
GetMean |
| Gets the mean of the values in the first in first out buffer | |
| - FLOAT
|
Return |
|
|
GetDeviation |
| Gets the standard deviation of the values in the first in first out buffer | |
| - FLOAT
|
Return |
|
|
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. | |
==Macro reference==
|
|
InitialiseFIFO |
| initialises the first in first out buffer values to 0 | |
| - VOID
|
Return |
|
|
AddSample |
| Adds a sample to the first in first out sample buffer. | |
| - FLOAT
|
Sample |
| Value to add into the FIFO buffer | |
| - VOID
|
Return |
|
|
GetMean |
| Gets the mean of the values in the first in first out buffer | |
| - FLOAT
|
Return |
|
|
GetDeviation |
| Gets the standard deviation of the values in the first in first out buffer | |
| - FLOAT
|
Return |
|
|
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. | |
==Macro reference==
|
|
InitialiseFIFO |
| initialises the first in first out buffer values to 0 | |
| - VOID
|
Return |
|
|
AddSample |
| Adds a sample to the first in first out sample buffer. | |
| - FLOAT
|
Sample |
| Value to add into the FIFO buffer | |
| - VOID
|
Return |
|
|
GetMean |
| Gets the mean of the values in the first in first out buffer | |
| - FLOAT
|
Return |
|
|
GetDeviation |
| Gets the standard deviation of the values in the first in first out buffer | |
| - FLOAT
|
Return |
|
|
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. | |
