xarray.DataArray.drop_vars#

DataArray.drop_vars(names, *, errors='raise')[source]#

Returns an array with dropped variables.

Parameters:

  • names (Hashable or iterable of Hashable) – Name(s) of variables to drop.

  • errors ({"raise", "ignore"}, default: "raise") – If ‘raise’, raises a ValueError error if any of the variable passed are not in the dataset. If ‘ignore’, any given names that are in the DataArray are dropped and no error is raised.

Returns:

dropped (Dataset) – New Dataset copied from self with variables removed.

Examples

>>> data = np.arange(12).reshape(4, 3)
>>> da = xr.DataArray(
...     data=data,
...     dims=["x", "y"],
...     coords={"x": [10, 20, 30, 40], "y": [70, 80, 90]},
... )
>>> da
<xarray.DataArray (x: 4, y: 3)>
array([[ 0,  1,  2],
       [ 3,  4,  5],
       [ 6,  7,  8],
       [ 9, 10, 11]])
Coordinates:
  * x        (x) int64 10 20 30 40
  * y        (y) int64 70 80 90

Removing a single variable:

>>> da.drop_vars("x")
<xarray.DataArray (x: 4, y: 3)>
array([[ 0,  1,  2],
       [ 3,  4,  5],
       [ 6,  7,  8],
       [ 9, 10, 11]])
Coordinates:
  * y        (y) int64 70 80 90
Dimensions without coordinates: x

Removing a list of variables:

>>> da.drop_vars(["x", "y"])
<xarray.DataArray (x: 4, y: 3)>
array([[ 0,  1,  2],
       [ 3,  4,  5],
       [ 6,  7,  8],
       [ 9, 10, 11]])
Dimensions without coordinates: x, y