pyriemann.geometry.tangentspace.norm¶
- pyriemann.geometry.tangentspace.norm(X, Cref, metric='riemann')[source]¶
Norm according to a specified metric.
It calculates the norm of the matrix \(\mathbf{X}\) in the tangent space at \(\mathbf{C}_\text{ref}\), according to a specified metric.
- Parameters:
- Xndarray, shape (…, n, n)
Matrices in the tangent space at Cref.
- Crefndarray, shape (n, n) | None
Reference matrix.
- metricstring | callable, default=”riemann”
Metric used for norm, can be: “euclid”, “logeuclid”, “riemann”, or a callable function.
- Returns:
- Nfloat or ndarray, shape (…,)
Norm of X.
See also
Notes
Added in version 0.11.
Changed in version 0.12: Add support for NumPy and PyTorch.