numpy.nanquantile#

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

计算沿指定轴的数据的第 q 个分位数,同时忽略 NaN 值。返回数组元素的第 q 个分位数。

参数:
a类数组对象

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

q浮点数类数组对象

要计算的分位数的概率或概率序列。值必须介于 0 和 1(含)之间。

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

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

outndarray,可选

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

overwrite_inputbool,可选

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

methodstr,可选

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

  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 不具有关键字参数 keepdims,这将引发 RuntimeError。

weights类数组对象,可选

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

2.0.0 版本新增。

interpolationstr,可选

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

自 1.22.0 版本起弃用。

返回:
quantile标量或 ndarray

如果 q 是单个概率且 axis=None,则结果是标量。如果给定多个概率级别,则结果的第一个轴对应于分位数。其他轴是 a 约简后保留的轴。如果输入包含小于 float64 的整数或浮点数,则输出数据类型为 float64。否则,输出数据类型与输入相同。如果指定了 out,则返回该数组。

另请参阅

quantile
nanmean, nanmedian
nanmedian

等同于 nanquantile(..., 0.5)

nanpercentile

与 nanquantile 相同,但 q 的范围为 [0, 100]。

注释

numpy.nanquantile 的行为与 numpy.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.quantile(a, 0.5)
np.float64(nan)
>>> np.nanquantile(a, 0.5)
3.0
>>> np.nanquantile(a, 0.5, axis=0)
array([6.5, 2. , 2.5])
>>> np.nanquantile(a, 0.5, axis=1, keepdims=True)
array([[7.],
       [2.]])
>>> m = np.nanquantile(a, 0.5, axis=0)
>>> out = np.zeros_like(m)
>>> np.nanquantile(a, 0.5, axis=0, out=out)
array([6.5, 2. , 2.5])
>>> m
array([6.5,  2. ,  2.5])
>>> b = a.copy()
>>> np.nanquantile(b, 0.5, axis=1, overwrite_input=True)
array([7., 2.])
>>> assert not np.all(a==b)