nansum¶
- sofia_redux.toolkit.utilities.func.nansum(a, axis=None, dtype=None, out=None, keepdims=0, missing=nan)[source]¶
Emulates the behaviour of np.nansum for NumPy versions <= 1.9.0.
Returns NaN if all elements of
a
are NaN rather than zero.- Parameters:
- aarray_like
Array containing numbers whose sum is desired. If
a
is not an array, a conversion is attempted.- axis{int, tuple of int, None}, optional
Axis or axes along which the sum is computed. The default is to compute the sum of the flattened array.
- dtypedata-type, optional
The type of the returned array and of the accumulator in which the elements are summed. By default, the dtype of
a
is used. An exception is whena
has an integer type with less precision than the platform (u)intp. In that case, the default will be either (u)int32 or (u)int64 depending on whether the platform is 32 or 64 bits. For inexact inputs, dtype must be inexact.- outndarray, optional
Alternate output array in which to place the result. The default is
None
. If provided, it must have the same shape as the expected output, but the type will be cast if necessary. See Output type determination for more details. The casting of NaN to integer can yield unexpected results.- keepdimsbool, optional
If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the original
a
. If the value is anything but the default, thenkeepdims
will be passed through to themean
orsum
methods of sub-classes ofndarray
. If the sub-classes methods does not implementkeepdims
any exceptions will be raised.- missingint or float, optional
The value to replace all NaN slices with. The default is NaN.
- Returns:
- nansumndarray.
A new array holding the result is returned unless
out
is specified, in which it is returned. The result has the same size asa
, and the same shape asa
ifaxis
is not None ora
is a 1-d array.