coords.Coords.cartesian_to_cylindrical#

Coords.cartesian_to_cylindrical(dir=(0, 1, 2), angle_spec=0.017453292519943295)#

Converts from cartesian to cylindrical coordinates.

Returns a Coords where the values are the coordinates of the input points in a cylindrical coordinate system. The three axes of the Coords then correspond to (r, theta, z).

Parameters#

dir: tuple of ints

A permutation of (0,1,2) specifying which of the global axes are the radial, circumferential and axial direction of the cylindrical coordinate system. Make sure to keep the axes ordering in order to get a right-handed system.

angle_spec: float, at.DEG or RAD, optional

Multiplication factor for angle coordinates. The default (at.DEG) returns angles in degrees. Use RAD to return angles in radians.

Returns#

Coords

The cylindrical coordinates of the input points.

See Also#

Examples#

see cylindrical_to_cartesian()