Integral
apama.analyticskit.blocks.core.Integral
Calculates the integral of the input value over time.
Integral is defined as the sum of the input's value multiplied by how long the input has stayed at that value, within an optional window, since the block was started or last reset.
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. Output is generated on any new input or, if the Output Threshold parameter is set, only when the output changes by more than the specified output threshold (which includes if no further input occurs, or the value only changes due to old entries expiring). The Sample input can be used to force re-evaluation and generate the latest value.
If a window is configured, the block will use a set of 20 buckets, so the expired value is an approximation of the average value across a bucket.
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 |
Output Threshold | If present, the output to be sent at the point when it changes by at least this value. This must be a finite and positive number. | float | Optional |
Input Port Details
Name | Description | Type |
Value | Input for which the integral is to be calculated. | float |
Reset | Clears the content of the window. | pulse |
Sample | Forces re-evaluation of the current integral value and sends the output. | pulse |
Output Port Details
Name | Description | Type |
Integral Value | The sum of the value multiplied by how long it stays at that value. | float |