Range (FPScript)
Determines global, floating or block ranges, i.e. differences between maxima and minima for a data set.
Syntax
Range(DataSet, [ Mode = PROCESS_COLUMNS ] [ , IntervalWidth ])
The syntax of the Range function consists of the following parts:
Part |
Description |
||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
DataSet |
The data set to be evaluated. All data structures are allowed. 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. |
||||||||||||||
Mode |
Specifies how data matrices and signal series are to be processed and whether individual, floating or block ranges are to be determined. If you omit the argument, individual ranges are determined column by column. The argument Mode can have the following values:
...plus an optional constant, which determines the calculation method.
If this argument is omitted, it will be set to the default value PROCESS_COLUMNS. |
||||||||||||||
IntervalWidth |
This argument is required for determining floating and block ranges. The interval width then specifies the number of values to be examined. The width should be an odd number. Otherwise, the interval is asymmetrical and, to the right of the center, one more value than on the left is included in the search. Permitted data structures are scalar value. All integral data types are permitted. The value must be greater or equal to 1. 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 always has the data type 64-bit floating point.
If DataSet is a scalar value, then 0 is always returned. For signals and signal series, the Y component is processed and the X or Z component is copied, if possible. When calculating floating and block ranges, the data structure of the result corresponds to that of the argument. If, on the other hand, the data set is a data series or a signal, the result is a scalar value with the range to be found. Otherwise, the result is a data series or a signal with one range per column or row.
Available in
FlexPro View, Basic, Professional, Developer Suite
Examples
Range({4, 6, 9, 3, 5, 4}) |
Results in 6.. |
Range({4, 6, 9, 3, 5, 4}, PROCESS_COLUMNS + CALC_MOVING, 3) |
Results in {2., 5., 6., 6., 2., 1.}. |
Range({4, 6, 9, 3, 5, 4}, PROCESS_COLUMNS + CALC_BLOCK, 3) |
Results in {5., 2.}. |