Ctrl+K

xcdat.get_dim_keys

Contents

xcdat.get_dim_keys#

xcdat.get_dim_keys(obj, axis)[source]#

Gets the dimension key(s) for an axis.

Each dimension should have a corresponding dimension coordinate variable, which has a 1:1 map in keys and is denoted by the * symbol when printing out the xarray object.

Parameters:

  • obj (Union[xr.Dataset, xr.DataArray]) – The Dataset or DataArray object.

  • axis (CFAxisKey) – The CF axis key (“X”, “Y”, “T”, or “Z”)

Returns:

Union[str, List[str]] – The dimension string or a list of dimensions strings for an axis.

Contents