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 个百分位数.

参数:
aarray_like

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

qfloat 类型的 array_like

要计算的百分位数或百分位数序列,必须介于 0 和 100 之间(含).

axis{int, tuple of int, None}, optional

计算百分位数的轴或多个轴. 默认值是沿数组的扁平化版本计算百分位数.

outndarray, 可选

用于放置结果的可选输出数组. 它必须具有与预期输出相同的形状和缓冲区长度,但是必要时将强制转换(输出的)类型.

overwrite_inputbool, 可选

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

methodstr, optional

此参数指定用于估计百分位数的方法. 有许多不同的方法,有些是 NumPy 独有的. 有关说明,请参见注释. H&F 论文 [1] 中总结的按其 R 类型排序的选项有:

  1. ‘inverted_cdf’

  2. ‘averaged_inverted_cdf’

  3. ‘closest_observation’

  4. ‘interpolated_inverted_cdf’

  5. ‘hazen’

  6. ‘weibull’

  7. ‘linear’ (默认)

  8. ‘median_unbiased’

  9. ‘normal_unbiased’

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

  • ‘lower’

  • ‘higher’,

  • ‘midpoint’

  • ‘nearest’

在 1.22.0 版本发生变更: 此参数之前被称为 “interpolation”,并且仅提供 “linear” 默认值和最后四个选项.

keepdimsbool, 可选

如果设置为 True,则缩减的轴将作为大小为 1 的维度保留在结果中. 使用此选项,结果将针对原始数组 a 正确广播.

如果这不是默认值,它将传递给(在空数组的特殊情况下)底层数组的 mean 函数.如果数组是子类并且 mean 没有 kwarg keepdims ,这将引发 RuntimeError.

weightsarray_like, optional

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

在 2.0.0 版本加入.

interpolationstr, optional

method 关键字参数的已弃用名称.

自 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 下的行为与参数为 q/100numpy.quantile 的行为相同(忽略 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)