Standard Deviation
apama.analyticskit.blocks.core.StandardDeviation
Calculates the standard deviation and variance of the values over time.
Standard deviation is a measure that is used to quantify the amount of variation or dispersion of a set of data values. A low standard deviation indicates that the data points tend to be close to the mean of the set, while a high standard deviation indicates that the data points are spread out over a wider range of values.
The block can operate over a time-bounded window that is specified with the Window Duration parameter. If this parameter is not specified, it uses an unbounded window. The Reset input clears the window contents. The Sample input can be used to force re-evaluation and generate the latest value. Output is generated on any new input or, if the Window Duration parameter is set, output is generated periodically on every new bucket that is added to the window.
If a window is configured, the block will use a set of 20 buckets, so the time of expired values is an approximation to the nearest bucket interval.
Parameters
Name | Description | Type | Notes |
Window Duration (secs) | If present, the amount of time (in seconds) for which values are to be kept in the window. This must be a finite and positive number. | float | Optional |
Input Port Details
Name | Description | Type |
Value | Input for which the standard deviation and variance is to be calculated. | float |
Reset | Clears the content of the window. | pulse |
Sample | Forces re-evaluation of the current value and sends the output. | pulse |
Output Port Details
Name | Description | Type |
Standard Deviation | The standard deviation of the input values. | float |
Variance | The variance of the input values. | float |