coordax.field

coordax.field(array: generic | bool | int | float | complex | ndarray | Array | NDArray | ShapeDtypeStruct, *names: str | Coordinate | None) → Field[source]

Wraps a positional array as a Field.

cx.field(array, *names) is a shortcut for cx.Field(array).tag(*names).

Parameters:

  • array – the array to wrap.

  • *names – the name or coordinates to attach to the array.

Returns:

A Field object.

Examples

>>> import coordax as cx
>>> import jax.numpy as jnp
>>> cx.field(jnp.ones((2, 3)), 'x', 'y')
<Field dims=('x', 'y') shape=(2, 3) axes={} >

See also

coordax.Field coordax.Field.tag()