pyriemann.geometry.tangentspace.log_map

pyriemann.geometry.tangentspace.log_map(X, Cref, *, metric='riemann')

Project matrices in tangent space by logarithmic map.

Parameters:

Xndarray, shape (…, n, n)

Matrices in manifold.

Crefndarray, shape (n, n)

Reference matrix.

metricstring | callable, default=”riemann”

Metric used for logarithmic map, can be: “euclid”, “logchol”, “logeuclid”, “riemann”, “wasserstein”, or a callable function.

Returns:

X_newndarray, shape (…, n, n)

Matrices projected in tangent space.

See also

log_map_euclid

log_map_logchol

log_map_logeuclid

log_map_riemann

log_map_wasserstein

Notes

Added in version 0.9.

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