numpy.percentile#

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

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

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

参数:
a实数数组类

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

q浮点数数组类

用于计算百分位数的百分比或百分比序列。值必须在 0 到 100 之间(含)。

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

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

outndarray,可选

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

overwrite_input布尔值,可选

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

method字符串,可选

此参数指定用于估计百分位数的方法。有许多不同的方法,其中一些是 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` 正确广播。

weightsarray_like, optional

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

版本 2.0.0 中新增。

返回:
percentile标量或 ndarray

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

另请参阅

mean
median

等同于 `percentile(..., 50)`

nanpercentile
quantile

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

备注

`numpy.percentile` 具有百分比 `q` 的行为与 `numpy.quantile` 具有参数 `q/100` 的行为相同。有关更多信息,请参阅 `numpy.quantile`。

参考

[1]

R. J. Hyndman 和 Y. Fan,“Sample quantiles in statistical packages”,The American Statistician,50(4),第 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