PolarTransform (FPScript)
Performs a polar transformation.
Syntax
PolarTransform(DataSet, [ Scale = POLARSCALE_RAD_PI ] [ , Unwrapped = FALSE ])
or
PolarTransform(Y, X, [ Scale = POLARSCALE_RAD_PI ] [ , Unwrapped = FALSE ])
The syntax of the PolarTransform function consists of the following parts:
Part |
Description |
||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
DataSet |
The data set with real or complex values to be polar transformed. Real data must be present as a signal. In this case the units of the Y and X components of DataSet must be compatible. In the case of complex data having the signal data structure, only the Y component is considered. Permitted data structures are data series und signal. 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. |
||||||||||
Y |
The Y component of the data to be transformed into polar coordinates. Only the Y component of a signal is used. Permitted data structures are data series und signal. All real 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. |
||||||||||
X |
The X component of the data to be transformed into polar coordinates. Only the Y component of a signal is used. The units of Y and X must be compatible. Permitted data structures are data series und signal. All real 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. |
||||||||||
Scale |
Determines the polar transform scaling. The argument Scale can have the following values:
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 POLARSCALE_RAD_PI. |
||||||||||
Unwrapped |
Specifies whether the polar transform phase response is unwrapped (to generate smooth phase responses). TRUE stands for phase unwrapping. Permitted data structures are scalar value. Supported data types are Boolean value. 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 FALSE. |
Remarks
The result always has the data type 64-bit floating point.
The result is a signal with the data transformed into polar coordinates. The Y component coincides with the absolute value and the X component coincides with the phase angle. The phase angle is calculated with the ArcTan2 function and is scaled afterwards.
The unit of the X component of the result is "°" or "rad" and the unit of the Y component coincides with the Y component of DataSet.
Available in
FlexPro View, Basic, Professional, Developer Suite
Examples
PolarTransform(YData, XData) |
Transforms the two data series to radians in the interval ]-Pi, Pi]. |