coordinates.mixins.core.CoordinateSystemAxesMixin.axes_complement#

CoordinateSystemAxesMixin.axes_complement(axes: Sequence[str]) → List[str][source]#

Return all axes in the coordinate system that are not present in axes.

Parameters:

axes (list of str) – Subset of axes to exclude.

Returns:

Canonically ordered axes not included in axes.

Return type:

list of str

Examples

>>> from pymetric.coordinates import SphericalCoordinateSystem
>>> cs = SphericalCoordinateSystem()
>>> cs.axes
['r', 'theta', 'phi']
>>> cs.axes_complement(["theta"])
['r', 'phi']