numpy.nanpercentile#

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

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

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

参数:
a类数组

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

q浮点数类数组

要计算的百分位数或百分位数序列,必须在 0 到 100 之间(含)。

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

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

outndarray, 可选

用于放置结果的备用输出数组。它必须与预期输出具有相同的形状和缓冲区长度,但如果需要,将对(输出)类型进行转换。

overwrite_inputbool, 可选

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

methodstr, 可选

此参数指定用于估计百分位数的方法。有许多不同的方法,其中一些是 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,则被缩减的轴将作为大小为一的维度保留在结果中。使用此选项,结果将正确地与原始数组 a 进行广播。

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

weights类数组, 可选

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

2.0.0 版本新增。

interpolationstr, 可选

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 的行为与 numpy.quantile 使用参数 q/100 的行为相同(忽略 nan 值)。更多信息请参阅 numpy.quantile

参考文献

[1]

R. J. Hyndman 和 Y. Fan,“统计软件包中的样本分位数”,《美国统计学家》,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)