coordinates.mixins.core.CoordinateSystemAxesMixin.is_axes_subset#

static CoordinateSystemAxesMixin.is_axes_subset(axes_a: Sequence[str], axes_b: Sequence[str]) bool[source]#

Check if axes_a is a subset of axes_b.

Parameters:
  • axes_a (Sequence[str]) – The axes to check as a potential subset.

  • axes_b (Sequence[str]) – The reference axes that should include all of axes_a.

Returns:

True if every axis in axes_a is in axes_b, else False.

Return type:

bool

Examples

>>> cs.is_subset(["r", "theta"], ["r", "theta", "phi"])
True
>>> cs.is_subset(["phi", "z"], ["r", "theta", "phi"])
False