pyriemann.geometry.mean.mean_harmonic

pyriemann.geometry.mean.mean_harmonic(X, sample_weight=None, **kwargs)

Harmonic mean of invertible matrices.

\[\mathbf{M} = \left( \sum_i w_i \ {\mathbf{X}_i}^{-1} \right)^{-1}\]

with \(w\) being the weights which sum to 1.

Parameters:

Xndarray, shape (…, n_matrices, n, n)

Set of invertible matrices.

sample_weightNone | ndarray, shape (n_matrices,), default=None

Weights for each matrix. If None, it uses equal weights.

Returns:

Mndarray, shape (…, n, n)

Harmonic mean.

See also

gmean

Notes

Changed in version 0.12: Add support for NumPy and PyTorch.