pyriemann.geometry.covariance.cross_spectrum

pyriemann.geometry.covariance.cross_spectrum(X, window=128, overlap=0.75, fmin=None, fmax=None, fs=None)[source]

Compute the complex cross-spectral matrices of a real signal.

Note that co-spectral matrices are the real part of cross-spectra.

Parameters:
Xndarray, shape (…, n_channels, n_times)

Multi-channel time-series, real-valued.

windowint, default=128

Length of the FFT window used for spectral estimation.

overlapfloat, default=0.75

Percentage of overlap between windows.

fminfloat | None, default=None

Minimal frequency to be returned.

fmaxfloat | None, default=None

Maximal frequency to be returned.

fsfloat | None, default=None

Sampling frequency of the time-series.

Returns:
Sndarray, shape (…, n_channels, n_channels, n_freqs)

Cross-spectral matrices, for each frequency bin.

freqsndarray, shape (n_freqs,)

Frequencies associated to cross-spectra.

Notes

Added in version 0.2.7.

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

References