bundles / numpy 2.4.4 / numpy / nanpercentile
_ArrayFunctionDispatcher
numpy:nanpercentile
Signature
def nanpercentile ( a , q , axis = None , out = None , overwrite_input = False , method = linear , keepdims = <no value> , * , weights = None ) Summary
Compute the qth percentile of the data along the specified axis, while ignoring nan values.
Extended Summary
Returns the qth percentile(s) of the array elements.
Parameters
a: array_likeInput array or object that can be converted to an array, containing nan values to be ignored.
q: array_like of floatPercentile or sequence of percentiles to compute, which must be between 0 and 100 inclusive.
axis: {int, tuple of int, None}, optionalAxis or axes along which the percentiles are computed. The default is to compute the percentile(s) along a flattened version of the array.
out: ndarray, optionalAlternative output array in which to place the result. It must have the same shape and buffer length as the expected output, but the type (of the output) will be cast if necessary.
overwrite_input: bool, optionalIf True, then allow the input array
ato be modified by intermediate calculations, to save memory. In this case, the contents of the inputaafter this function completes is undefined.method: str, optionalThis parameter specifies the method to use for estimating the percentile. There are many different methods, some unique to NumPy. See the notes for explanation. The options sorted by their R type as summarized in the H&F paper [1] are:
'inverted_cdf'
'averaged_inverted_cdf'
'closest_observation'
'interpolated_inverted_cdf'
'hazen'
'weibull'
'linear' (default)
'median_unbiased'
'normal_unbiased'
The first three methods are discontinuous. NumPy further defines the following discontinuous variations of the default 'linear' (7.) option:
'lower'
'higher',
'midpoint'
'nearest'
keepdims: bool, optionalIf 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 array
a.If this is anything but the default value it will be passed through (in the special case of an empty array) to the
meanfunction of the underlying array. If the array is a sub-class andmeandoes not have the kwargkeepdimsthis will raise a RuntimeError.weights: array_like, optionalAn array of weights associated with the values in
a. Each value inacontributes to the percentile according to its associated weight. The weights array can either be 1-D (in which case its length must be the size ofaalong the given axis) or of the same shape asa. Ifweights=None, then all data inaare assumed to have a weight equal to one. Onlymethod="inverted_cdf"supports weights.
Returns
percentile: scalar or ndarrayIf
qis a single percentile andaxis=None, then the result is a scalar. If multiple percentiles are given, first axis of the result corresponds to the percentiles. The other axes are the axes that remain after the reduction ofa. If the input contains integers or floats smaller thanfloat64, the output data-type isfloat64. Otherwise, the output data-type is the same as that of the input. Ifoutis specified, that array is returned instead.
Notes
The behavior of numpy.nanpercentile with percentage q is that of numpy.quantile with argument q/100 (ignoring nan values). For more information, please see numpy.quantile.
Examples
import numpy as np a = np.array([[10., 7., 4.], [3., 2., 1.]]) a[0][1] = np.nan✓
a
✗np.percentile(a, 50)
✓np.nanpercentile(a, 50)
✗np.nanpercentile(a, 50, axis=0) np.nanpercentile(a, 50, axis=1, keepdims=True) m = np.nanpercentile(a, 50, axis=0) out = np.zeros_like(m) np.nanpercentile(a, 50, axis=0, out=out)✓
m
✗b = a.copy() np.nanpercentile(b, 50, axis=1, overwrite_input=True) assert not np.all(a==b)✓
See also
- mean
- median
- nanmean
- nanmedian
equivalent to
nanpercentile(..., 50)- nanquantile
equivalent to nanpercentile, except q in range [0, 1].
- percentile
Aliases
-
numpy.nanpercentile