NextValueInBurst (FPScript)
Searches for the next value in a burst starting from a given position.
Syntax
NextValueInBurst(DataSet, [ Position ], Threshold, DeltaX [ , Direction = EVENT_RIGHT ])
The syntax of the NextValueInBurst function consists of the following parts:
Part |
Description |
||||||
|---|---|---|---|---|---|---|---|
DataSet |
The data set to be searched. Permitted data structures are data series und signal. All numeric data types are permitted. For complex data types the absolute value is formed. If the argument is a list, then the function is executed for each element of the list and the result is also a list. |
||||||
Position |
If you are searching in a signal, this is the X value where the search is to start. If you are searching a data series, this is the index of the value where the search is to start. Here, a negative index determines a position relative to the end of the data set. If you omit the argument or pass the value Empty, the search starts at the beginning or end of the data set, depending on the direction of the search. The first or last value of the data set is only taken into account if you omit the argument or pass the Empty value. Permitted data structures are scalar value. All numeric data types are permitted. The unit has to be compatible with that of parameter DataSet. For complex data types the absolute value is formed. If the argument is a list, then the function is executed for each element of the list and the result is also a list. |
||||||
Threshold |
Specifies the threshold value for the burst search. Those values are assigned to a burst, for which at least one of the neighboring values in the interval [-DeltaX, DeltaX] to the left or right lies above the threshold value. Permitted data structures are scalar value. All numeric data types are permitted. For complex data types the absolute value is formed. If the argument is a list, then the function is executed for each element of the list and the result is also a list. |
||||||
DeltaX |
Determines the interval [-DeltaX, DeltaX], within which at least one value has to lie above the threshold value in order to assign the value to be examined to the burst. Permitted data structures are scalar value. All numeric data types are permitted. The unit has to be compatible with that of parameter DataSet. For complex data types the absolute value is formed. If the argument is a list, then the function is executed for each element of the list and the result is also a list. |
||||||
Direction |
Specifies the direction of the search in the function. The argument Direction can have the following values:
If the argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated. If this argument is omitted, it will be set to the default value EVENT_RIGHT. |
Remarks
A value is recognized as belonging to a burst if the value itself or at least one of the neighboring values in the interval [-DeltaX, DeltaX] to the left or right is above the threshold. If DataSet is a data series, the result is the index of the value found. If DataSet is a signal, the result is the X value. If no next value could be found in a burst, the value Empty is output as the result.
The following illustration shows a signal with two highlighted bursts:
Available in
FlexPro Basic, Professional, Developer Suite
Examples
NextValueInBurst(Signal, , 0.2 V, 0.1 s, EVENT_LEFT) |
Searches within a signal for the next value in a burst, starting at the end of the signal and heading to the left. The threshold value is 0.2 V and the X interval [-0.1 s, 0.1 s]. The result is the X value of the burst found. |
Signal[[NextValueInBurst(Signal, 4.5 s, 0.2 V, 0.1 s)]] |
Searches within a signal for the next value in a burst, starting from the position X = 4.5 s and heading to the right. The result is the Y value of the position found. |