nlcpy.nanstd

nlcpy.nanstd(a, axis=None, dtype=None, out=None, ddof=0, keepdims=nlcpy._NoValue)

Computes the standard deviation along the specified axis, while ignoring NaNs.

Returns the standard deviation, a measure of the spread of a distribution, of the non-NaN array elements. The standard deviation is computed for the flattened array by default, otherwise over the specified axis. For all-NaN slices or slices with zero degrees of freedom, NaN is returned and a RuntimeWarning is raised.

Parameters

aarray_like: Calculate the standard deviation of the non-NaN values.
axisint, None, optional: Axis along which the standard deviation is computed. The default is to compute the standard deviation of the flattened array.
dtypedtype, optional: Type to use in computing the standard deviation. For arrays of integer type the default is float64, for arrays of float types it is the same as the array type.
outndarray, optional: Alternative output array in which to place the result. It must have the same shape as the expected output but the type (of the calculated values) will be cast if necessary.
ddofint, optional: Means Delta Degrees of Freedom. The divisor used in calculations is N - ddof, where N represents the number of non-NaN elements. By default, ddof is zero.
keepdimsbool, optional: If this is set to True, the axis 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.

Returns

standard_deviationndarray, see dtype parameter above.: If out is None, return a new array containing the standard deviation, otherwise return a reference to the output array. If ddof is >= the number of non-NaN elements in a slice or the slice contains only NaNs, then the result for that slice is NaN.

See also

var: Computes the variance along the specified axis.
mean: Computes the arithmetic mean along the specified axis.
std: Computes the standard deviation along the specified axis.
nanvar: Computes the variance along the specified axis, while ignoring NaNs.
nanmean: Computes the arithmetic mean along the specified axis, ignoring NaNs.

Note

The standard deviation is the square root of the average of the squared deviations from the mean: std = sqrt(mean(abs(x - x.mean())**2)).

The average squared deviation is normally calculated as x.sum() / N, where N = len(x). If, however, ddof is specified, the divisor N - ddof is used instead. In standard statistical practice, ddof=1 provides an unbiased estimator of the variance of the infinite population. ddof=0 provides a maximum likelihood estimate of the variance for normally distributed variables. The standard deviation computed in this function is the square root of the estimated variance, so even with ddof=1, it will not be an unbiased estimate of the standard deviation per se.

For floating-point input, the std is computed using the same precision the input has. Depending on the input data, this can cause the results to be inaccurate, especially for float32 (see example below). Specifying a higher-accuracy accumulator using the dtype keyword can alleviate this issue.

Restriction

If axis is neither a scalar nor None : NotImplementedError occurs.
For complex numbers : NotImplementedError occurs.

Examples

>>> import nlcpy as vp
>>> a = vp.array([[1, vp.nan], [3, 4]])
>>> vp.nanstd(a)    
array(1.24721913)
>>> vp.nanstd(a, axis=0)
array([1., 0.])
>>> vp.nanstd(a, axis=1)
array([0. , 0.5])