Skip to content

Commit

Permalink
updated epochs docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
tsbinns committed Sep 9, 2023
1 parent 42085e1 commit 402cfaa
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions mne_connectivity/spectral/epochs.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down

0 comments on commit 402cfaa

Please sign in to comment.