xarray.core.weighted.DataArrayWeighted.sum_of_squares#
- DataArrayWeighted.sum_of_squares(dim=None, *, skipna=None, keep_attrs=None)[source]#
Reduce this Dataset’s data by a weighted
sum_of_squares
along some dimension(s).- Parameters
dim (
Hashable
orIterable
ofHashable
, optional) – Dimension(s) over which to apply the weightedsum_of_squares
.skipna (
bool
orNone
, 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
orNone
, 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 weightedsum_of_squares
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).