Skip to content

Commit

Permalink
[DOC] Improve documentation of freqs (#242)
Browse files Browse the repository at this point in the history
Co-authored-by: Daniel McCloy <[email protected]>
  • Loading branch information
richardkoehler and drammock authored Oct 14, 2024
1 parent 6cdc28f commit 1a8fb48
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
15 changes: 10 additions & 5 deletions mne_connectivity/spectral/epochs.py
Original file line number Diff line number Diff line change
Expand Up @@ -790,12 +790,15 @@ def spectral_connectivity_epochs(
Spectrum estimation mode can be either: 'multitaper', 'fourier', or
'cwt_morlet'. Ignored if ``data`` is an
:class:`~mne.time_frequency.EpochsSpectrum` object.
fmin : float | tuple of float
fmin : float | tuple of float | None
The lower frequency of interest. Multiple bands are defined using
a tuple, e.g., (8., 20.) for two bands with 8Hz and 20Hz lower freq.
a tuple, e.g., (8., 20.) for two bands with 8 Hz and 20 Hz lower freq.
If ``None``, the frequency corresponding to 5 cycles based on the epoch
length is used. For example, with an epoch length of 1 sec, the lower
frequency would be 5 / 1 sec = 5 Hz.
fmax : float | tuple of float
The upper frequency of interest. Multiple bands are dedined using
a tuple, e.g. (13., 30.) for two band with 13Hz and 30Hz upper freq.
a tuple, e.g. (13., 30.) for two band with 13 Hz and 30 Hz upper freq.
fskip : int
Omit every "(fskip + 1)-th" frequency bin to decimate in frequency
domain.
Expand Down Expand Up @@ -828,8 +831,10 @@ def spectral_connectivity_epochs(
bandwidth. Only used in 'multitaper' mode. Ignored if ``data`` is an
:class:`~mne.time_frequency.EpochsSpectrum` object.
cwt_freqs : array
Array of frequencies of interest. Only used in 'cwt_morlet' mode. Ignored if
``data`` is an :class:`~mne.time_frequency.EpochsSpectrum` object.
Array of frequencies of interest. Only used in 'cwt_morlet' mode. Only
the frequencies within the range specified by ``fmin`` and ``fmax`` are
used. Ignored if ``data`` is an
:class:`~mne.time_frequency.EpochsSpectrum` object.
cwt_n_cycles : float | array of float
Number of cycles. Fixed number or one per frequency. Only used in 'cwt_morlet'
mode. Ignored if ``data`` is an :class:`~mne.time_frequency.EpochsSpectrum`
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ doc = [
'pooch',
'pydata-sphinx-theme==0.14.1',
'PyQt6',
'sphinx',
'sphinx!=8.1.0',
'sphinx-copybutton',
'sphinx-design',
'sphinx-gallery>=0.17.0',
Expand Down

0 comments on commit 1a8fb48

Please sign in to comment.