pyriemann.datasets.make_covariances

pyriemann.datasets.make_covariances(n_matrices, n_channels, rs=None, return_params=False, evals_mean=2.0, evals_std=0.1)

Generate a set of covariances matrices, with the same eigenvectors.

Parameters
n_matricesint

Number of matrices to generate.

n_channelsint

Number of channels in covariance matrices.

rsRandomState instance, default=None

Random state for reproducible output across multiple function calls.

return_paramsbool, default=False

If True, then return parameters.

evals_meanfloat, default=2.0

Mean of eigen values.

evals_stdfloat, default=0.1

Standard deviation of eigen values.

Returns
covmatsndarray, shape (n_matrices, n_channels, n_channels)

Covariances matrices.

evalsndarray, shape (n_matrices, n_channels)

Eigen values used for each covariance matrix. Only returned if return_params=True.

evecsndarray, shape (n_channels, n_channels)

Eigen vectors used for all covariance matrices. Only returned if return_params=True.