Threshold
apama.analyticskit.blocks.core.Threshold
Compares the input value against the defined threshold value to detect whether the input breaches the threshold or whether it crosses the threshold.
A breach occurs when the direction has been set to 'Above' and the input value is greater than the defined threshold value, or when the direction has been set to 'Below' and the input value is less than the defined threshold, or when the direction has been set to 'Above or Equal' and the input value is greater than or equal to the defined threshold value, or when the direction has been set to 'Below or Equal' and the input value is less than or equal to the defined threshold value.
A pulse is sent when the defined threshold value is crossed from any direction.
Parameters
Name | Description | Type | Notes |
Threshold Value | This value is compared against the input value. | float | |
Direction | The direction in which to look: whether the input value is above, below or equal to the defined threshold, or whether it crosses the defined threshold. | Option - one of:  Above Above or Equal Below Below or Equal Crossing | Default: above |
Input Port Details
Name | Description | Type |
Value | The input value to compare against the defined threshold value. | float |
Reset | Resets the state of the block. | pulse |
Output Port Details
Name | Description | Type |
Breached Threshold | Is set to true when the threshold is breached. | boolean |
Within Threshold | Is set to true when the threshold is not breached. | boolean |
Crossed Threshold | Sends a pulse when the threshold is crossed. | pulse |