scipp.nansum

scipp.nansum(x, dim=None, *, out=None)

Element-wise sum over the specified dimension; NaNs ignored.

See scipp.sum() on how rounding errors for float32 inputs are handled.

Parameters

• x (Union[Variable, DataArray, Dataset]) – Input data.

• dim (Optional[str], default: None) – Optional dimension along which to calculate the sum. If not given, the sum over all dimensions is calculated.

• out (Union[Variable, DataArray, Dataset, None], default: None) – Optional output buffer.

Raises

If the dimension does not exist, or the dtype cannot be summed, e.g., if it is a string.

Returns

Union[Variable, DataArray, Dataset] – The sum of the input values with NaNs set to zero.

Seealso

scipp.sum().