numpy.percentile#

numpy.percentile(a, q, axis=None, out=None, overwrite_input=False, method='linear', keepdims=False, *, weights=None, interpolation=None)[源码]#

计算数据沿指定轴的第 q 个百分位数。

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

参数:
a实数数组类对象

可转换为数组的输入数组或对象。

q浮点数数组类对象

要计算的百分位数(百分比或百分比序列)。值必须在 0 到 100 之间(含 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 正确广播。

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,则返回该数组。

另请参阅

mean
median

等同于 percentile(..., 50)

nanpercentile
quantile

等同于 percentile,除了 q 的范围在 [0, 1] 之间。

注释

numpy.percentile 使用百分比 q 时的行为与参数为 q/100numpy.quantile 相同。有关更多信息,请参阅 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
array([[10,  7,  4],
       [ 3,  2,  1]])
>>> np.percentile(a, 50)
3.5
>>> np.percentile(a, 50, axis=0)
array([6.5, 4.5, 2.5])
>>> np.percentile(a, 50, axis=1)
array([7.,  2.])
>>> np.percentile(a, 50, axis=1, keepdims=True)
array([[7.],
       [2.]])
>>> m = np.percentile(a, 50, axis=0)
>>> out = np.zeros_like(m)
>>> np.percentile(a, 50, axis=0, out=out)
array([6.5, 4.5, 2.5])
>>> m
array([6.5, 4.5, 2.5])
>>> b = a.copy()
>>> np.percentile(b, 50, axis=1, overwrite_input=True)
array([7.,  2.])
>>> assert not np.all(a == b)

不同方法可以图形化展示

import matplotlib.pyplot as plt

a = np.arange(4)
p = np.linspace(0, 100, 6001)
ax = plt.gca()
lines = [
    ('linear', '-', 'C0'),
    ('inverted_cdf', ':', 'C1'),
    # Almost the same as `inverted_cdf`:
    ('averaged_inverted_cdf', '-.', 'C1'),
    ('closest_observation', ':', 'C2'),
    ('interpolated_inverted_cdf', '--', 'C1'),
    ('hazen', '--', 'C3'),
    ('weibull', '-.', 'C4'),
    ('median_unbiased', '--', 'C5'),
    ('normal_unbiased', '-.', 'C6'),
    ]
for method, style, color in lines:
    ax.plot(
        p, np.percentile(a, p, method=method),
        label=method, linestyle=style, color=color)
ax.set(
    title='Percentiles for different methods and data: ' + str(a),
    xlabel='Percentile',
    ylabel='Estimated percentile value',
    yticks=a)
ax.legend(bbox_to_anchor=(1.03, 1))
plt.tight_layout()
plt.show()
../../_images/numpy-percentile-1.png