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
data : ndarray, shape ([n_epochs, ]n_signals, n_times) or generator
The data to process. If a generator, it must return 2D arrays to process.
n_iter :
intThe maximum number of iterations to perform.
tol :
floatThe relative tolerance for convergence.
verbose : bool |
str|int|NoneControl verbosity of the logging output. If
None, use the default verbosity level. See the logging documentation andmne.verbose()for details. Should only be passed as a keyword argument.- Returns
data_orth :
ndarray, shape (n_epochs, n_signals, n_times) | generatorThe orthogonalized data. If
datais a generator, a generator is returned.
References
- 1
G. L. Colclough, M. J. Brookes, S. M. Smith, and M. W. Woolrich. A symmetric multivariate leakage correction for MEG connectomes. NeuroImage, 117:439–448, August 2015. doi:10.1016/j.neuroimage.2015.03.071.
