xoa.coords.get_fdim

xoa.coords.get_fdim(da, errors='warn', **kwargs)[source]

Get the dimension of F type

It is a simple call to get_dims() with dim_types="f"

Parameters:
  • da (xarray.DataArray) – Array to scan

  • 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

  • kwargs (dict) – Extra parameters are passed to get_cf_dims()

Returns:

str or None – The dimension name or None

See also

get_cf_dims