xarray.core.weighted.DataArrayWeighted.sum#

DataArrayWeighted.sum(dim=None, skipna=None, keep_attrs=None)[source]#

Reduce this Dataset’s data by a weighted sum along some dimension(s).

Parameters
  • dim (str or sequence of str, optional) – Dimension(s) over which to apply the weighted sum.

  • skipna (bool, optional) – If True, skip missing values (as marked by NaN). By default, only skips missing values for float dtypes; other dtypes either do not have a sentinel missing value (int) or skipna=True has not been implemented (object, datetime64 or timedelta64).

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

Returns

reduced (Dataset) – New Dataset object with weighted sum applied to its data and the indicated dimension(s) removed.

Notes

Returns 0 if the weights sum to 0.0 along the reduced dimension(s).