numpy.nanpercentile#

numpy.nanpercentile(a, q, axis=None, out=None, overwrite_input=False, method='linear', keepdims=<no value>, *, weights=None, interpolation=None)[源代码]#

计算沿指定轴的数据的第 q 个百分位数,同时忽略 nan 值.

返回数组元素的第 q 个百分位数.

在 1.9.0 版本加入.

参数:
aarray_like

可以转换为数组的输入数组或对象,包含要忽略的 nan 值.

q类数组的浮点数

要计算的百分位数或百分位数序列,必须在 0 到 100 之间(包括 0 和 100).

axis{int, int 的元组, None}, 可选

计算百分位数的轴或轴.默认是计算数组展平版本的百分位数.

outndarray, 可选

要在其中放置结果的替代输出数组.它必须具有与预期输出相同的形状和缓冲区长度,但如果需要,输出类型将被强制转换.

overwrite_inputbool, 可选

如果为真,则允许输入数组 a 被中间计算修改,以节省内存.在这种情况下,此函数完成后输入 a 的内容是未定义的.

methodstr, 可选

此参数指定用于估计百分位数的方法.有许多不同的方法,其中一些是NumPy特有的.请参阅注释以获取解释.按其在H&F论文[Re21b1d0b0470-1]_中总结的R类型排序的选项有:

  1. ‘inverted_cdf’

  2. ‘averaged_inverted_cdf’

  3. ‘closest_observation’

  4. ‘interpolated_inverted_cdf’

  5. ‘hazen’

  6. ‘weibull’

  7. ‘linear’ (默认)

  8. ‘中位数无偏’

  9. ‘normal_unbiased’

前三种方法是间断的.NumPy 进一步定义了以下默认 ‘linear’ (7.) 选项的间断变体:

  • ‘lower’

  • ‘更高’,

  • ‘中点’

  • ‘nearest’

在 1.22.0 版本发生变更: 这个参数之前被称为”插值”,并且只提供”线性”默认值和最后四个选项.

keepdimsbool, 可选

如果设置为 True,被减少的轴将作为尺寸为1的维度保留在结果中.使用此选项,结果将正确地与原始数组 a 进行广播.

如果这不是默认值,它将被传递(在空数组的特殊情况下)到基础数组的 mean 函数.如果数组是子类,并且 mean 没有 keepdims 这个关键字参数,这将引发一个 RuntimeError.

weightsarray_like, 可选

a 中值相关的一组权重.`a` 中的每个值根据其相关权重对百分位数做出贡献.权重数组可以是 1-D(在这种情况下,其长度必须与 a 沿给定轴的大小相同)或与 a 的形状相同.如果 weights=None,则假定 a 中的所有数据具有等于一的权重.只有 method=”inverted_cdf” 支持权重.

在 2.0.0 版本加入.

interpolationstr, 可选

该方法关键字参数的弃用名称.

自 1.22.0 版本弃用.

返回:
percentile标量或ndarray

如果 q 是一个单一的百分位数并且 axis=None,那么结果是一个标量.如果给出了多个百分位数,结果的第一个轴对应于这些百分位数.其他的轴是 a 在减少后剩余的轴.如果输入包含小于 float64 的整数或浮点数,则输出数据类型是 float64.否则,输出数据类型与输入相同.如果指定了 out,则返回该数组.

参见

nanmean
nanmedian

等同于 nanpercentile(..., 50)

percentile, median, mean
nanquantile

等效于 nanpercentile,除了 q 在范围 [0, 1] 内.

备注

numpy.nanpercentile 在百分比 q 下的行为等同于 numpy.quantile 在参数 q/100 下的行为(忽略 nan 值).更多信息请参见 numpy.quantile.

参考文献

[1]

R. J. Hyndman and Y. Fan, “Sample quantiles in statistical packages,” The American Statistician, 50(4), pp. 361-365, 1996

示例

>>> import numpy as np
>>> a = np.array([[10., 7., 4.], [3., 2., 1.]])
>>> a[0][1] = np.nan
>>> a
array([[10.,  nan,   4.],
      [ 3.,   2.,   1.]])
>>> np.percentile(a, 50)
np.float64(nan)
>>> np.nanpercentile(a, 50)
3.0
>>> np.nanpercentile(a, 50, axis=0)
array([6.5, 2. , 2.5])
>>> np.nanpercentile(a, 50, axis=1, keepdims=True)
array([[7.],
       [2.]])
>>> m = np.nanpercentile(a, 50, axis=0)
>>> out = np.zeros_like(m)
>>> np.nanpercentile(a, 50, axis=0, out=out)
array([6.5, 2. , 2.5])
>>> m
array([6.5,  2. ,  2.5])
>>> b = a.copy()
>>> np.nanpercentile(b, 50, axis=1, overwrite_input=True)
array([7., 2.])
>>> assert not np.all(a==b)