numpy.ma.average#

ma.average(a, axis=None, weights=None, returned=False, *, keepdims=<no value>)[source]#

返回数组在给定轴上的加权平均值。

参数：:
aarray_like

要平均的数据。计算中不考虑掩码条目。

axisNone 或 int 或 int 元组，可选

要平均 a 的轴或轴。默认值 axis=None 将对输入数组的所有元素进行平均。如果轴是 int 元组，则将对元组中指定的所有轴进行平均，而不是像以前一样对单个轴或所有轴进行平均。

weightsarray_like，可选

与 a 中的值相关联的权重数组。 a 中的每个值都根据其关联的权重对平均值有贡献。权重数组必须与 a 的形状相同，如果未指定轴，否则权重必须具有与 a 沿着指定轴一致的维度和形状。如果 weights=None，则假定 a 中的所有数据权重都等于 1。计算为

avg = sum(a * weights) / sum(weights)

其中，求和是针对所有包含的元素进行的。 weights 值的唯一约束是 sum(weights) 必须不为 0。

returnedbool，可选

标志指示是否应返回一个元组 (result, sum of weights) 作为输出 (True)，或者只返回结果 (False)。默认值为 False。

keepdimsbool，可选

如果将其设置为 True，则减少的轴将保留在结果中，作为大小为 1 的维度。使用此选项，结果将与原始 a 正确广播。注意： keepdims 将不适用于 numpy.matrix 或其方法不支持 keepdims 的其他类的实例。

新版 1.23.0 中添加。

返回：:
average, [sum_of_weights](元组) 标量或 MaskedArray

沿着指定轴的平均值。当 returned 为 True 时，返回一个元组，其中平均值作为第一个元素，权重的总和作为第二个元素。如果 a 是整数类型并且浮点数小于 float64，则返回类型为 np.float64，否则为输入数据类型。如果返回，sum_of_weights 始终为 float64。

引发：:
ZeroDivisionError

当轴上的所有权重都为零时。请参阅 numpy.ma.average 以了解针对此类错误的稳健版本。

TypeError

当 weights 与 a 的形状不同，并且 axis=None 时。

ValueError

当 weights 的维度和形状与 a 沿着指定的 axis 不一致时。

示例

>>> import numpy as np
>>> a = np.ma.array([1., 2., 3., 4.], mask=[False, False, True, True])
>>> np.ma.average(a, weights=[3, 1, 0, 0])
1.25

>>> x = np.ma.arange(6.).reshape(3, 2)
>>> x
masked_array(
  data=[[0., 1.],
        [2., 3.],
        [4., 5.]],
  mask=False,
  fill_value=1e+20)
>>> data = np.arange(8).reshape((2, 2, 2))
>>> data
array([[[0, 1],
        [2, 3]],
       [[4, 5],
        [6, 7]]])
>>> np.ma.average(data, axis=(0, 1), weights=[[1./4, 3./4], [1., 1./2]])
masked_array(data=[3.4, 4.4],
         mask=[False, False],
   fill_value=1e+20)
>>> np.ma.average(data, axis=0, weights=[[1./4, 3./4], [1., 1./2]])
Traceback (most recent call last):
    ...
ValueError: Shape of weights must be consistent
with shape of a along specified axis.

>>> avg, sumweights = np.ma.average(x, axis=0, weights=[1, 2, 3],
...                                 returned=True)
>>> avg
masked_array(data=[2.6666666666666665, 3.6666666666666665],
             mask=[False, False],
       fill_value=1e+20)

使用 keepdims=True，以下结果的形状为 (3, 1)。

>>> np.ma.average(x, axis=1, keepdims=True)
masked_array(
  data=[[0.5],
        [2.5],
        [4.5]],
  mask=False,
  fill_value=1e+20)
本页内容