xarray.Dataset.set_xindex

xarray.Dataset.set_xindex#

Dataset.set_xindex(coord_names, index_cls=None, **options)[source]#

Set a new, Xarray-compatible index from one or more existing coordinate(s).

Parameters

  • coord_names (str or list) – Name(s) of the coordinate(s) used to build the index. If several names are given, their order matters.

  • index_cls (subclass of Index, optional) – The type of index to create. By default, try setting a PandasIndex if len(coord_names) == 1, otherwise a PandasMultiIndex.

  • **options – Options passed to the index constructor.

Returns

obj (Dataset) – Another dataset, with this dataset’s data and with a new index.

Contents