Python SciPy mstats.hmean用法及代码示例

本文简要介绍 python 语言中 scipy.stats.mstats.hmean 的用法。

用法:

scipy.stats.mstats.hmean(a, axis=0, dtype=None, *, weights=None, nan_policy='propagate', keepdims=False)#

计算沿指定轴的加权调和平均值。

与权重 \(w_i\) 关联的数组 \(a_i\) 的加权调和平均值为：

\[\frac{ \sum_{i=1}^n w_i }{ \sum_{i=1}^n \frac{w_i}{a_i} } \, ,\]

并且，具有相同的权重，它给出：

\[\frac{ n }{ \sum_{i=1}^n \frac{1}{a_i} } \, .\]

参数 ：：

a： array_like

输入数组、掩码数组或可以转换为数组的对象。

axis： int 或无，默认值：0

如果是 int，则计算统计量的输入轴。输入的每个axis-slice(例如行)的统计信息将出现在输出的相应元素中。如果 None ，输入将在计算统计数据之前被分解。

dtype： dtype，可选

返回数组的类型和对元素求和的累加器的类型。如果未指定 dtype，则默认为 a 的 dtype，除非 a 具有精度小于默认平台整数的整数 dtype。在这种情况下，将使用默认平台整数。

weights： 数组，可选

权重数组可以是一维的(在这种情况下，它的长度必须是沿给定轴的 a 的大小)或与 a 具有相同的形状。默认为无，它为每个值赋予 1.0 的权重。

nan_policy： {‘propagate’, ‘omit’, ‘raise’}

定义如何处理输入 NaN。

• propagate ：如果计算统计数据的轴切片(例如行)中存在NaN，则输出的相应条目将为 NaN。

• omit : 计算时将省略NaNs。如果计算统计数据的轴切片中剩余的数据不足，则输出的相应条目将为 NaN。

• raise ：如果存在 NaN，则会引发 ValueError。

keepdims： 布尔值，默认值：假

如果将其设置为 True，则缩小的轴将作为尺寸为 1 的尺寸留在结果中。使用此选项，结果将针对输入数组正确广播。

返回 ：：

hmean： ndarray

请参见上面的 dtype 参数。

注意：

调和平均值是在输入数组的一个维度上计算的，默认情况下轴 = 0，或者如果轴 = 无，则计算数组中的所有值。 float64 中间值和返回值用于整数输入。

从 SciPy 1.9 开始，np.matrix 输入(不建议用于新代码)在执行计算之前转换为 np.ndarray。在这种情况下，输出将是标量或适当形状的 np.ndarray 而不是 2D np.matrix 。同样，虽然屏蔽数组的屏蔽元素被忽略，但输出将是标量或 np.ndarray 而不是带有 mask=False 的屏蔽数组。

参考：

[1]

“Weighted Harmonic Mean”,维基百科,https://en.wikipedia.org/wiki/Harmonic_mean#Weighted_harmonic_mean

[2]

Ferger, F.，“调和平均值的性质和使用”，美国统计协会杂志，第一卷。 26，第 36-40 页，1931

例子：

>>> from scipy.stats import hmean
>>> hmean([1, 4])
1.6000000000000001
>>> hmean([1, 2, 3, 4, 5, 6, 7])
2.6997245179063363
>>> hmean([1, 4, 7], weights=[3, 1, 3])
1.9029126213592233