pyriemann.geometry.covariance.covariances_X

pyriemann.geometry.covariance.covariances_X(*args, **kwargs)

Warning

DEPRECATED: covariances_X() is deprecated and will be removed in 0.14.0.

Special form covariance matrix, embedding input X.

Parameters:

Xndarray, shape (…, n_channels, n_times)

Multi-channel time-series.

estimatorstring | callable, default=”cov”

Covariance matrix estimator, see pyriemann.geometry.covariance.covariances().

alphafloat, default=0.2

Regularization parameter (strictly positive).

**kwdsoptional keyword parameters

Any further parameters are passed directly to the covariance estimator.

Returns:

covmatsndarray, shape (…, n_channels + n_times, n_channels + n_times)

Covariance matrices.

Notes

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

References

[1]

A special form of SPD covariance matrix for interpretation and visualization of data manipulated with Riemannian geometry M. Congedo and A. Barachant, MaxEnt - 34th International Workshop on Bayesian Inference and Maximun Entropy Methods in Science and Engineering (MaxEnt’14), Sep 2014, Amboise, France. pp.495