xarray.Dataset.dggs.decode

xarray.Dataset.dggs.decode#

Dataset.dggs.decode(grid_info=None, *, name='cell_ids', index_options=None, **index_kwargs)#

decode the DGGS cell ids

Parameters:

  • grid_info (dict or DGGSInfo, optional) – Override the grid parameters on the dataset. Useful to set attributes on the dataset.

  • name (str, default: "cell_ids") – The name of the coordinate containing the cell ids.

  • index_options, **index_kwargs (dict, optional) – Additional options to forward to the index.

Returns:

obj (xarray.DataArray or xarray.Dataset) – The object with a DGGS index on the cell id coordinate.

Contents