xarray.IndexVariable.all#

IndexVariable.all(dim=None, **kwargs)[source]#

Reduce this NamedArray’s data by applying all along some dimension(s).

Parameters:

  • dim (str, Iterable of Hashable, "..." or None, default: None) – Name of dimension[s] along which to apply all. For e.g. dim="x" or dim=["x", "y"]. If “…” or None, will reduce over all dimensions.

  • **kwargs (Any) – Additional keyword arguments passed on to the appropriate array function for calculating all on this object’s data. These could include dask-specific kwargs like split_every.

Returns:

reduced (NamedArray) – New NamedArray with all applied to its data and the indicated dimension(s) removed

See also

numpy.all, dask.array.all, Dataset.all, DataArray.all

Aggregation

User guide on reduction or aggregation operations.

Examples

>>> from xarray.namedarray.core import NamedArray
>>> na = NamedArray(
...     "x", np.array([True, True, True, True, True, False], dtype=bool)
... )
>>> na
<xarray.NamedArray (x: 6)> Size: 6B
array([ True,  True,  True,  True,  True, False])

>>> na.all()
<xarray.NamedArray ()> Size: 1B
array(False)
On this page