mne_connectivity.symmetric_orth#

mne_connectivity.symmetric_orth(data, *, n_iter=50, tol=1e-06, verbose=None)[source]#

Perform symmetric orthogonalization.

Uses the method from [1] to jointly orthogonalize the time series.

Parameters:
datandarray, shape ([n_epochs, ]n_signals, n_times) or generator

The data to process. If a generator, it must return 2D arrays to process.

n_iterint

The maximum number of iterations to perform.

tolfloat

The relative tolerance for convergence.

verbosebool | str | int | None

Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns:
data_orthndarray, shape (n_epochs, n_signals, n_times) | generator

The orthogonalized data. If data is a generator, a generator is returned.

References

Examples using mne_connectivity.symmetric_orth#

Compute envelope correlations in source space

Compute envelope correlations in source space