Attention

This repository has been archived. Please use xarray.DataTree instead.

datatree.DataTree.squeeze

DataTree.squeeze(dim: Hashable | Iterable[Hashable] | None = None, drop: bool = False, axis: int | Iterable[int] | None = None) → Self

Return a new object with squeezed data.

Parameters:

• dim (None or Hashable or iterable of Hashable, optional) – Selects a subset of the length one dimensions. If a dimension is selected with length greater than one, an error is raised. If None, all length one dimensions are squeezed.

• drop (bool, default: False) – If drop=True, drop squeezed coordinates instead of making them scalar.

• axis (None or int or iterable of int, optional) – Like dim, but positional.

Returns:

squeezed (same type as caller) – This object, but with with all or a subset of the dimensions of length 1 removed.

See also

numpy.squeeze