numpy.nanquantile#

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

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

版本 1.15.0 中的新增功能。

参数::
aarray_like

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

qarray_like of float

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

axis{int, tuple of 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,则将减少的轴保留在结果中,作为大小为 1 的维度。使用此选项,结果将针对原始数组 a 正确广播。

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

weightsarray_like, 可选

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

版本 2.0.0 中的新增功能。

interpolationstr, 可选

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

从版本 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 和 Y. Fan,“统计软件包中的样本分位数”,《美国统计学家》,50(4),第 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)