ValuesBelowLevel (FPScript)
Searches a data set for values below a certain level.
Syntax
ValuesBelowLevel(DataSet, Level, [ Operation = EVENT_DEFAULT ], [ DeltaXmin ] [ , DeltaXmax ])
The syntax of the ValuesBelowLevel function consists of the following parts:
Part |
Description |
||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
DataSet |
The data set to be searched. Permitted data structures are data series, data matrix, signal und signal series. 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. |
||||||||||||
Level |
Specifies the level below which the values must lie. 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. |
||||||||||||
Operation |
Specifies the way the function operates. The argument Operation 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_DEFAULT. |
||||||||||||
DeltaXmin |
Optionally determines the minimum duration or number of values that an event must endure to be valid. If you search within a signal, this is the X range from the first value of the event to the last value of the event. If you search within a data series, this is the minimum number of data points that the event must have. 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 first element in the list is taken. If this is also a list, then the process is repeated. |
||||||||||||
DeltaXmax |
Optionally determines the maximum duration or number of values that an event can endure to be valid. If you search within a signal, this is the X range from the first value of the event to the last value of the event. If you search within a data series, this is the maximum number of data points that the event can have. 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 first element in the list is taken. If this is also a list, then the process is repeated. |
Remarks
Values that are exactly on the level are also found.
Available in
FlexPro Basic, Professional, Developer Suite
Examples
ValuesBelowLevel({1, 5, 7, 4, 3}, 5) |
Results in {0L, 1L, 3L, 4L}. The result are indices of the values below the level. |
ValuesBelowLevel({1, 7, 6, 4, 3}, 5, , 2) |
Results in {3L, 4L}. The result are indices of the values below the level. There must be at least two neighboring values of the event. |
ValuesBelowLevel(Signal({1, 7, 6, 4, 3}, (5, 0, 1)), 5, , 2) |
Results in {}. No indices are found, since the X range of the neighboring values below the level is smaller than 2. |