numpy.nanquantile#

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

在指定的轴上计算数据的 q 分位数,同时忽略 nan 值。返回数组元素的 q 分位数。

参数:
a类数组对象

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

q浮点数数组类

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

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` 正确广播。

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

weightsarray_like, optional

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

版本 2.0.0 中新增。

返回:
分位数标量或 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,“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[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)