OrderCuts (FPScript)
Cuts order curves (if necessary by RMS or maximum calculation in a line band) from an order spectrum.
Syntax
OrderCuts(OrderSpectrum, Orders, [ OrderComponent = ORDERCUTS_ORDER_IS_X ], [ ExtractionMode = ORDERCUTS_EXTRACTIONMODE_WITHOUT_BANDWIDTH ], [ LeftBandwidth = 0.125 ], [ RightBandwidth = 0.125 ], [ ResultStructure = ORDERCUTS_RESULTSTRUCTURE_SIGNALSERIES ] [ , ListNames ])
The syntax of the OrderCuts function consists of the following parts:
Part |
Description |
||||||||
|---|---|---|---|---|---|---|---|---|---|
OrderSpectrum |
The order spectrum (i.e. signal series with Z component, which contains the orders on the X or Z component), from which individual order lines are to be extracted in a vertical or horizontal direction. Permitted data structures are signal series. All numeric data types are permitted, except calendar time und time span. If the argument is a list, then the function is executed for each element of the list and the result is also a list. |
||||||||
Orders |
The orders to be extracted. Permitted data structures are data series. All real data types are permitted, except Boolean value, calendar time und time span. Void values are not permitted in this argument. |
||||||||
OrderComponent |
Component specification of the order spectrum, which contains the orders. Therefore, determines the direction in which the lines are cut out of the order spectrum. The argument OrderComponent can have the following values:
If this argument is omitted, it will be set to the default value ORDERCUTS_ORDER_IS_X. |
||||||||
ExtractionMode |
Determines whether the individual order lines are to be extracted without bandwidth or calculated by RMS or maximum calculation in a line band. The argument ExtractionMode can have the following values:
If this argument is omitted, it will be set to the default value ORDERCUTS_EXTRACTIONMODE_WITHOUT_BANDWIDTH. |
||||||||
LeftBandwidth |
The left-hand order bandwidths for extracting and calculating the individual order curves. The argument is only considered if ExtractionMode was specified as ORDERCUTS_EXTRACTIONMODE_MAXIMUM_IN_BANDWIDTH or ORDERCUTS_EXTRACTIONMODE_RMS_IN_BANDWIDTH. Permitted data structures are scalar value und data series. All real data types are permitted, except Boolean value, calendar time und time span. Void values are not permitted in this argument. If this argument is omitted, it will be set to the default value 0.125. |
||||||||
RightBandwidth |
The right-hand order bandwidths for extracting and calculating the individual order curves. The argument is only considered if ExtractionMode was specified as ORDERCUTS_EXTRACTIONMODE_MAXIMUM_IN_BANDWIDTH or ORDERCUTS_EXTRACTIONMODE_RMS_IN_BANDWIDTH. Permitted data structures are scalar value und data series. All real data types are permitted, except Boolean value, calendar time und time span. Void values are not permitted in this argument. If this argument is omitted, it will be set to the default value 0.125. |
||||||||
ResultStructure |
Determines the result structure of the cut order lines. The argument ResultStructure can have the following values:
If this argument is omitted, it will be set to the default value ORDERCUTS_RESULTSTRUCTURE_SIGNALSERIES. |
||||||||
ListNames |
A data series with several element names or a list from which the element names are to be extracted. If you omit the argument or specify too few names, automatic element names are formed from the orders to be cut. Permitted data structures are data series und list. Supported data types are string. |
Remarks
In particular, the function is used to extract order curves from an order spectrum.
Available in
Option Order Tracking
Examples
OrderCuts(orderspectrum, {4, 11, 25, 27}, ORDERCUTS_ORDER_IS_Z, ORDERCUTS_EXTRACTIONMODE_WITHOUT_BANDWIDTH)
Extracts 4 orders from an order spectrum (without bandwidth). The result is returned as a signal series containing the specified orders 4, 11, 25 and 27 on the Z components.
OrderCuts(orderspectrum, {1, 1.5, 2}, ORDERCUTS_ORDER_IS_X, ORDERCUTS_EXTRACTIONMODE_RMS_IN_BANDWIDTH, 0.2, 0.2)
Extracts 3 order lines from an order spectrum at orders 1, 1.5, and 2. Here, the cut lines are calculated, energy-conserving, in the bands [0.8, 1.2], [1.3, 1.7] and [1.8, 2.2] (root of the square sum in the order band). This mode is only useful if the order spectrum was calculated with spectrum type "RMS amplitude" and power normalized window normalization. The lines are returned as a signal series.
OrderCuts(orderspectrum, {1, 1.5, 2}, ORDERCUTS_ORDER_IS_X, ORDERCUTS_EXTRACTIONMODE_RMS_IN_BANDWIDTH, 0.2, 0.2, ORDERCUTS_RESULTSTRUCTURE_LIST)
Corresponds to the previous example with the difference that the order curves are now output as a list. The list element names are "Order 1", "Order 1.5" and "Order 2".
See Also
RevolutionSyncSampling Function