xoa.coords.get_dim_types

Contents

xoa.coords.get_dim_types#

xoa.coords.get_dim_types(da, unknown=None, asdict=False)[source]#

Get dimension types

Parameters:

  • da (xarray.DataArray or tuple(str)) – Data array or tuple of dimensions

  • unknown – Value to assign to unknown types

  • asdict (bool) – Get the result as a dictionary mapping dimension names to types

Returns:

tuple or dict – Dimension types as single-letter strings (“x”, “y”, “z”, “t”, “f”) or unknown for unrecognized dimensions.

Example

>>> da = xr.DataArray(np.ones((3, 4)), dims=("lat", "lon"))
>>> get_dim_types(da, unknown="-")
('y', 'x')
>>> get_dim_types(da, asdict=True)
{'lat': 'y', 'lon': 'x'}
Contents