Signal Hold
This topic describes the Signal Hold component.
Feature description
The Signal Hold component holds a specified signal for the duration of a holding epoch.
Calculation logic
The algorithm has two states: holding and non-holding. By default, the algorithm starts in the non-holding state.
In the holding state
If the holding epoch has not ended, the component outputs the previous output signal.
When the holding epoch ends, the state changes to non-holding.
In the non-holding state
If the input signal is different from the previous output signal and the input quality code is good, the component outputs the current input signal. The state then changes to holding and the epoch count is reset.
Otherwise, the component outputs the previous output signal.
Note: The epoch count increases by 1 each time the component runs. A quality code is bad if its value is in the range [0, 192). A quality code is good if its value is -1 or is 192 or greater.
Parameter description
IN port - Input parameters
Parameter Name | Description | Required | Input Data Type | Data Source Type |
in | The variable to which the hold feature is applied. | Yes | Any | Any |
OUT port - Output parameters
Parameter Name | Description | Output Data Type |
out | The output variable. | Same as the input data type |
Other parameters
Parameter Name | Description | Required | Default Value | Valid Range |
Epoch Retention | The number of epochs to hold the input signal. One run of the component equals one epoch. | Yes | 1 | [1,9999] |
Output quality code description
The output quality code is determined as follows:
In the holding state: The output quality code is the same as the previous output quality code.
In the non-holding state:
If the input quality code is bad, the output quality code is the same as the previous output quality code.
If the input quality code is good, the output quality code is the same as the current input quality code.
If the input quality code is missing or is not numeric, the output quality code is -1.
Good quality code: The quality code value is -1 or is 192 or greater.
Bad quality code: The quality code value is in the range [0, 192).