coordax.from_xarray¶

coordax.from_xarray(data_array: xarray.DataArray, coord_types: Sequence[type[Coordinate]] = (<class 'coordax.LabeledAxis'>, <class 'coordax.DummyAxis'>)) → Field[source]¶

Create a coordax.Field from an xarray.DataArray.

Parameters:

data_array – xarray.DataArray to convert into a Field.
coord_types – sequence of coordax.Coordinate subclasses with from_xarray methods defined. The first coordinate class that returns a coordinate object (indicating a match) will be used. By default, coordinates will use only generic LabeledAxis and DummyAxis objects.

Returns:

A coordax.Field object with the same data as the input xarray.DataArray.

Examples

>>> import coordax as cx
>>> import xarray as xr
>>> import numpy as np
>>> da = xr.DataArray(np.zeros((2, 3)), dims=('x', 'y'), coords={'x': [1, 2]})
>>> cx.from_xarray(da)
<Field dims=('x', 'y') shape=(2, 3) axes={'x': LabeledAxis} >