GlobalExtrema (FPScript)

21.09.2021

Searches for global minima and/or maxima in a data set.

Syntax

GlobalExtrema(DataSet, [ Orientation = EVENT_BOTH ] [ , Operation = EVENT_DEFAULT ])

 

The syntax of the GlobalExtrema 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.

Orientation

Specifies whether to search for minima, maxima or both.

The argument Orientation can have the following values:

Constant

Meaning

EVENT_POSITIVE

Search for global maxima only.

EVENT_NEGATIVE

Search for global minima only.

EVENT_BOTH

Search for global minima and maxima.

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_BOTH.

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.

Remarks

Global maxima or minima are all occurrences of the largest or smallest value in the data set.

Available in

FlexPro Basic, Professional, Developer Suite

Examples

GlobalExtrema({1, 3, 5, 4, 1}, EVENT_BOTH, EVENT_INDEX)

Results in {0L, 2L, 4L}. The minimum occurs twice.

See Also

NextGlobalExtremum Function

GlobalMaximum Function

GlobalMinimum Function

Event Isolation Analysis Object

Share article or send as email:

You might be interested in these articles