pyriemann.utils.distance.distance_harmonic

pyriemann.utils.distance.distance_harmonic(A, B, squared=False)

Harmonic distance between invertible matrices.

The harmonic distance between two invertible matrices \(\mathbf{A}\) and \(\mathbf{B}\) is:

\[d(\mathbf{A},\mathbf{B}) = \Vert \mathbf{A}^{-1} - \mathbf{B}^{-1} \Vert_F\]
Parameters:
Andarray, shape (…, n, n)

First invertible matrices, at least 2D ndarray.

Bndarray, shape (…, n, n)

Second invertible matrices, same dimensions as A.

squaredbool, default=False

Return squared distance.

Added in version 0.5.

Returns:
dfloat or ndarray, shape (…,)

Harmonic distance between A and B.

See also

distance