Mondaic
This API reference is not for the latest stable Salvus version.

salvus.geometry.coordinates.coordinates

Coordinates and coordinates systems.

Classes

CoordinateSystem

class CoordinateSystem(enum.Enum):
    def __init__(self): ...

The coordinate system.

Coordinates

class Coordinates(builtins.object):
    def __init__(
        self,
        coordinates: npt.ArrayLike,
        coordinate_system: CoordinateSystem | None = None,
        reference: _Reference = salvus.geometry.coordinates.references.Absolute,
    ): ...

A class representing 2-D and 3-D coordinates.

Parameters
  • coordinates npt.ArrayLike — The coordinate array of shape [NUM_POINTS, (2, 3)].
  • coordinate_system CoordinateSystem | None — The coordinate system. Will default to a cartesian system if not given.
  • reference _Reference — The reference for the coordinates. Will default to an absolute reference if not given.
Attributes
coordinate_system CoordinateSystem

Return the coordinate system for the coordinates.

ndim int

Dimensionality of the coordinates.

reference _Reference

Return the reference for the coordinates.