SlopesAtLevel (FPScript)

21.09.2021

Searches within a data set for slopes of a specified minimum steepness that have to pass through a particular level.

Syntax

SlopesAtLevel(DataSet, Level, DeltaY, DeltaX, Hysteresis, [ Orientation = EVENT_BOTH ] [ , Operation = EVENT_DEFAULT ])

 

The syntax of the SlopesAtLevel 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 the slopes have to pass through.

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.

DeltaY

Specifies the minimum Y interval by which the amplitude is to rise or fall so that a slope can be recognized.

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.

DeltaX

Specifies the X interval within which the amplitude must rise or fall by at least the DeltaY amount.

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.

Hysteresis

Specifies the maximum amount by which the signal amplitude is allowed to swing within a slope in the opposite direction.

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.

Orientation

Specifies whether to search for falling and/or rising slopes.

The argument Orientation can have the following values:

Constant

Meaning

EVENT_POSITIVE

Search for rising slopes only.

EVENT_NEGATIVE

Search for falling slopes only.

EVENT_BOTH

Search for falling and rising slopes.

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

The slopes are characterized by the fact that the amplitude rises or falls within the X difference DeltaX by at least the DeltaY amount. With regard to DeltaX an increment of 1 is assumed for the data series and data matrix.

Available in

FlexPro Basic, Professional, Developer Suite

Examples

SlopesAtLevel({0, 0.4, 1., 1.2, 1.3, 1.2, 1.4, 0.7, 0.3, 0.1}, 0.5, 0.5, 5, 0.3)

Results in {1L, 7L}. Searches for rising and falling slopes within the specified data set. The indices are returned at which the level 0.5 is crossed with the required steepness.

See Also

NextSlopeAtLevel Function

Slopes Function

NextSlope Function

Event Isolation Analysis Object

Share article or send as email:

You might be interested in these articles