ValuesAboveLevel (FPScript)

21.09.2021

Searches a data set for values above a certain level.

Syntax

ValuesAboveLevel(DataSet, Level, [ Operation = EVENT_DEFAULT ], [ DeltaXmin ] [ , DeltaXmax ])

 

The syntax of the ValuesAboveLevel 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 above 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:

Constant

Meaning

EVENT_INDEX

The indices of the values or points meeting the condition are placed in the result data set.

EVENT_EXTRACT

Only the points or values meeting the condition are transferred into the result data set.

EVENT_SETVOID

The points or values that do not meet the condition are also included in the result data set, but there they are marked as void.

EVENT_DEFAULT

Corresponds to EVENT_SETVOID if a data matrix or signal series is present, and otherwise EVENT_INDEX.

+ EVENT_COMPLEMENT

This constant can be optionally added and then reverses the selected operation. Then, for example, for EVENT_EXTRACT, the points that do not meet the condition are copied.

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

ValuesAboveLevel({1, 5, 7, 4, 3}, 5)

Results in {1L, 2L}. The result are indices of the values above the level.

ValuesAboveLevel({1, 5, 7, 4, 3}, 5, , 2)

Results in {1L, 2L}. The result are indices of the values above the level. Two indices are found, since at least two values are above the level.

ValuesAboveLevel(Signal({1, 5, 7, 4, 3}, (5, 0, 1)), 5, , 2)

Results in {}. No indices are found, since the X range of the neighboring values above the level is 1.

See Also

ValuesBelowLevel Function

LevelCrossings Function

PositivePeaks Function

NegativePeaks Function

ValuesInInterval Function

TimePeriods Function

NextValueAboveLevel Function

NextValueBelowLevel Function

Trigger Function

Event Isolation Analysis Object

Share article or send as email:

You might be interested in these articles