From 402cfaa43b6f5827c3d44d262fa843ab3d849a07 Mon Sep 17 00:00:00 2001 From: Thomas Samuel Binns Date: Sat, 9 Sep 2023 13:00:12 +0200 Subject: [PATCH] updated epochs docstring --- mne_connectivity/spectral/epochs.py | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/mne_connectivity/spectral/epochs.py b/mne_connectivity/spectral/epochs.py index 5158b3c0..7ad551c9 100644 --- a/mne_connectivity/spectral/epochs.py +++ b/mne_connectivity/spectral/epochs.py @@ -1641,13 +1641,15 @@ def spectral_connectivity_epochs(data, names=None, method='coh', indices=None, con : array | list of array Computed connectivity measure(s). Either an instance of ``SpectralConnectivity`` or ``SpectroTemporalConnectivity``. - The shape of each connectivity dataset is either: - (n_cons, n_freqs) mode: 'multitaper' or 'fourier'; or - (n_cons, n_freqs, n_times) mode: 'cwt_morlet'. When "indices" is None - and a bivariate method is called, "n_cons = n_signals ** 2", or if a - multivariate method is called "n_cons = 1". When "indices" is - specified, "n_con = len(indices[0])" for bivariate and multivariate - methods. + The shape of the connectivity result will be: + + - ``(n_cons, n_freqs)`` for multitaper or fourier modes + - ``(n_cons, n_freqs, n_times)`` for cwt_morlet mode + - ``n_cons = n_signals ** 2`` for bivariate methods with + ``indices=None`` + - ``n_cons = 1`` for multivariate methods with ``indices=None`` + - ``n_cons = len(indices[0])`` for bivariate and multivariate methods + when indices is supplied. See Also --------