coordax.get_coordinate

coordax.get_coordinate(field: Field, *, missing_axes: Literal['error', 'dummy', 'skip'] = 'dummy') → Coordinate

Returns a single coordinate for a field.

Parameters:

• field – coordax.Field from which the coordinate will be extracted.

• missing_axes –

  controls how axes without coorinates are handled. Options are:

  • 'dummy': uses DummyAxis for dimensions without a coordinate.

  • 'skip': ignores dimensions without a coordinate.

  • 'error': raises if dimensions without a coordinate are present.

Returns:

Coordinate associated with the field.

Examples

>>> import coordax as cx
>>> import jax.numpy as jnp
>>> x = cx.SizedAxis('x', 2)
>>> field = cx.field(jnp.zeros((2, 3)), x, 'y')
>>> cx.get_coordinate(field)
CartesianProduct(coordinates=(coordax.SizedAxis('x', size=2), coordax.DummyAxis('y', size=3)))