numpy.ma.average#

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

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

参数:
a类数组对象

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

axisNone 或 int 或 int 元组，可选

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

weightsarray_like, optional

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

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

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

returnedbool, optional

标志，指示是否应将元组 (result, sum of weights) 作为输出（True）返回，还是仅返回结果（False）。默认为 False。

keepdimsbool，可选

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

新版本 1.23.0。

返回:
average, [sum_of_weights](tuple of) scalar or MaskedArray

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

引发:
ZeroDivisionError

当沿轴的所有权重都为零时。有关能对此类错误具有鲁棒性的版本，请参阅 numpy.ma.average。

TypeError

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

ValueError

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

示例

>>> 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)
在此页面