Represents a collection of points in 3D space.

Public members¶

x1 : ndarray[Any, dtype[_ScalarType_co]]

Coordinates in first dimension

x2 : ndarray[Any, dtype[_ScalarType_co]]

Coordinates in second dimension

x3 : ndarray[Any, dtype[_ScalarType_co]]

Coordinates in third dimension

system : CoordinateSystem

The type of coordinates being used

Constructors¶

Coords(x1: numpy.typing.NDArray, x2: numpy.typing.NDArray, x3, ...)

Initialize self. See help(type(self)) for accurate signature.

Special methods¶

__iter__() → Iterator[TypeAliasForwardRef('numpy.typing.NDArray')]

Iterate over the individual coordinates of the points.

__len__() → int

Return the number of points present in the collection.

__getitem__(idx: int | tuple[int, ...]) → Coord

Return the coordinates of an individual point.

__repr__()

Return repr(self).

__eq__(other)

Return self==value.

Methods¶

iter_points() → Iterator[Coord]

Iterate over the points held in this object.

offset(dx3: numpy.typing.ArrayLike) → Coords

Change the x3 coordinate by the specified ammount.

to_cartesian() → Coords

Convert the points to be in Cartesian coordiantes.

get_set(index) → FrozenCoordSet[Coord]

Get a set of individual point objects from the collection.

to_coord() → Coord

Convert the object to a Coord object.

round_to(figures: int = 8) → Coords

Round coordinate values to the desired number of significant figures.

to_slice_coords() → SliceCoords

Get the poloidal components of this coordinate.

Properties¶

property shape : tuple[int, ...]

Return the logical shape of the coordinate array.