Clip (FPScript)
Clips the amplitude of a data set.
Syntax
Clip(DataSet, [ LowerLimit ] [ , UpperLimit ])
The syntax of the Clip function consists of the following parts:
Part |
Description |
|---|---|
DataSet |
The data set for which the amplitude is to be clipped. All data structures are allowed, except scalar value und list. All numeric data types are permitted. If the argument is a list, then the function is executed for each element of the list and the result is also a list. |
LowerLimit |
The lower limit for the amplitude. If there is to be no limit at the bottom, you can omit the argument or specify ? or Empty. Permitted data structures are scalar value. All numeric data types are permitted. The unit has to be compatible with that of parameter DataSet. 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. |
UpperLimit |
The upper limit for the amplitude. If there is to be no limit at the top, you can omit the argument or specify ? or Empty. Permitted data structures are scalar value. All numeric data types are permitted. The unit has to be compatible with that of parameter DataSet. 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
The result has the same structure and unit as the argument DataSet.
If DataSet is of the calendar time or time span data type, then this also applies for the result. For all other DataSet data types, the data type of the result is a 64-bit floating point value.
All values above the upper or below the lower limit are set to the relevant limiting value.
Available in
FlexPro Basic, Professional, Developer Suite
Examples
Clip(Signal, -0.8, 0.8) |
Limits the amplitude of a signal to the interval [-0.8, 0.8]. |
Clip(Signal, , 0.8)) |
Limits the amplitude of a signal only at the top to the value 0.8. |