xoa.coords.get_dims¶

xoa.coords.get_dims(da, dim_types, allow_positional=False, positions='tzyx', errors='warn')[source]¶

Get the data array dimensions names from their type

Parameters

da (xarray.DataArray) – Array to scan
dim_types (str, list) – Letters among “x”, “y”, “z”, “t” and “f”.
allow_positional (bool) – Fall back to positional dimension of types if unkown.
positions (str) – Default position per type starting from the end.
errors ({'ignore', 'warn', 'raise'}) –
In case of errors
- ignore: silently ignore
- warn: emit a warning
- raise: raise an exception

Returns

tuple – Tuple of dimension name or None when the dimension if not found