xdas.DataArray.swap_dims#

DataArray.swap_dims(dims_dict=None, **dims_kwargs)[source]#

Return a new DataArray with swapped dimensions.

Parameters:

dims_dict (dict-like) – Dictionary whose keys are current dimension names and whose values are new names.
**dims_kwargs ({existing_dim: new_dim, ...}, optional) – The keyword arguments form of dims_dict. One of dims_dict or dims_kwargs must be provided.

Returns:

swapped – DataArray with swapped dimensions.

Return type:

DataArray

Examples

>>> import xdas as xd

>>> da = xd.DataArray(
...     data=[0, 1],
...     coords={"x": ["a", "b"], "y": ("x", [0, 1])},
... )
>>> da
<xdas.DataArray (x: 2)>
[0 1]
Coordinates:
  * x (x): ['a' 'b']
    y (x): [0 1]

Make y the dimensional coordinate:

>>> da.swap_dims({"x": "y"})
<xdas.DataArray (y: 2)>
[0 1]
Coordinates:
    x (y): ['a' 'b']
  * y (y): [0 1]

Assign a new empy coordinate z as dimensional coordinate. Use the **kwargs syntax this time:

>>> da.swap_dims(x="z")
<xdas.DataArray (z: 2)>
[0 1]
Coordinates:
    x (z): ['a' 'b']
    y (z): [0 1]
Dimensions without coordinates: z