pyriemann.datasets.make_covariances

pyriemann.datasets.make_covariances(*args, **kwargs)

Warning

DEPRECATED: make_covariances is deprecated and will be removed in 0.6.0; please use make_matrices.

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.