xoa.coords.get_vertical

Contents

xoa.coords.get_vertical#

xoa.coords.get_vertical(da, errors='raise', **kwargs)[source]#

Get either depth or altitude

Tries to find a depth coordinate first, then falls back to altitude.

Parameters:
  • da (xarray.DataArray, xarray.Dataset)

  • errors ({'ignore', 'warn', 'raise'}) –

    In case of errors

    • 'ignore': silently ignore

    • 'warn': emit a warning

    • 'raise': raise an exception

  • kwargs – Extra parameters are passed to xoa.meta.MetaSpecs.search()

Returns:

xarray.DataArray or None

See also

get_lon, get_lat, get_depth, get_altitude, get_level, get_time, xoa.meta.MetaSpecs.search