ILMathcart2pol Method (InArraySingle, InArraySingle, InArraySingle, OutArraySingle, OutArraySingle)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Transforms scalar coordinates into polar (cylindrical) coordinates.

[ILNumerics Computing Engine]

Namespace: ILNumerics
Assembly: ILNumerics.Computing (in ILNumerics.Computing.dll) Version: 5.5.0.0 (5.5.7503.3146)

Syntax

Copy

public static RetArray<float> cart2pol(
	InArray<float> X,
	InArray<float> Y,
	InArray<float> Z,
	OutArray<float> Radius = null,
	OutArray<float> outZ = null
)

Public Shared Function cart2pol ( 
	X As InArray(Of Single),
	Y As InArray(Of Single),
	Z As InArray(Of Single),
	Optional Radius As OutArray(Of Single) = Nothing,
	Optional outZ As OutArray(Of Single) = Nothing
) As RetArray(Of Single)

Dim X As InArray(Of Single)
Dim Y As InArray(Of Single)
Dim Z As InArray(Of Single)
Dim Radius As OutArray(Of Single)
Dim outZ As OutArray(Of Single)
Dim returnValue As RetArray(Of Single)

returnValue = ILMath.cart2pol(X, Y, 
	Z, Radius, outZ)

Parameters

X: Type: ILNumericsInArraySingle
X coordinates.
Y: Type: ILNumericsInArraySingle
Y coordinates.
Z: Type: ILNumericsInArraySingle
Z coordinates (height).
Radius (Optional): Type: ILNumericsOutArraySingle
[Optional] Output: radius. Default: (null) do not compute.
outZ (Optional): Type: ILNumericsOutArraySingle
[Optional] Output: Copy of Z. Default: (null) do not return.

Return Value

Type: RetArraySingle
Angles. Radius and Z values are returned as output parameters if requested on entry (i.e.: not null).

Remarks

X, Y, and Z must be the same size or broadcastable to each other. Polar coordinate arrays returned are of the same size as the broadcasted size of the input arrays.

If outZ is requested it will have the same values as Z and the same broadcasted size of the output.

[ILNumerics Computing Engine]

Reference

ILMath Class

cart2pol Overload

ILNumerics Namespace