Representation of a collection of points in an x1-x2 plane.

Public members¶

x1 : ndarray[Any, dtype[_ScalarType_co]]

Coordinates in first dimension

x2 : ndarray[Any, dtype[_ScalarType_co]]

Coordinates in second dimension

system : CoordinateSystem

The type of coordinates being used

Constructors¶

SliceCoords(x1: numpy.typing.NDArray, x2: numpy.typing.NDArray, ...)

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

Special methods¶

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

Iterate over the coordinates of the points.

__len__() → int

Return the number of points contained in the object.

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

Return an individual point from the collection.

__repr__()

Return repr(self).

__eq__(other)

Return self==value.

Methods¶

iter_points() → Iterator[SliceCoord]

Iterate over the points held in this object.

get_set(index) → FrozenCoordSet[SliceCoord]

Get a set of individual point objects from the collection.

round_to(figures: int = 8) → SliceCoords

Round coordinate values to the desired number of significant figures.

to_coord() → SliceCoord

Convert the object to a SliceCoord object.

to_3d_coords(x3: float) → Coords

Create a 3D coordinates object from this 2D one.

Properties¶

property shape : tuple[int, ...]

Return the logical shape of the coordinate array.