xarray.core.groupby.DataArrayGroupBy.all

DataArrayGroupBy.all(dim=None, keep_attrs=None, **kwargs)[source]

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

Parameters
  • dim (hashable or iterable of hashable, optional) – Name of dimension[s] along which to apply all. For e.g. dim="x" or dim=["x", "y"]. If None, will reduce over all dimensions present in the grouped variable.

  • keep_attrs (bool, optional) – If True, attrs will be copied from the original object to the new one. If False (default), the new object will be returned without attributes.

  • **kwargs (dict) – Additional keyword arguments passed on to the appropriate array function for calculating all on this object’s data.

Returns

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

Examples

>>> da = xr.DataArray(
...     np.array([True, True, True, True, True, False], dtype=bool),
...     dims="time",
...     coords=dict(
...         time=("time", pd.date_range("01-01-2001", freq="M", periods=6)),
...         labels=("time", np.array(["a", "b", "c", "c", "b", "a"])),
...     ),
... )
>>> da
<xarray.DataArray (time: 6)>
array([ True,  True,  True,  True,  True, False])
Coordinates:
  * time     (time) datetime64[ns] 2001-01-31 2001-02-28 ... 2001-06-30
    labels   (time) <U1 'a' 'b' 'c' 'c' 'b' 'a'
>>> da.groupby("labels").all()
<xarray.DataArray (labels: 3)>
array([False,  True,  True])
Coordinates:
  * labels   (labels) object 'a' 'b' 'c'

See also

numpy.all, DataArray.all

GroupBy: split-apply-combine

User guide on groupby operations.