mne-tools / mne-connectivity

Connectivity algorithms that leverage the MNE-Python API.
https://mne.tools/mne-connectivity/dev/index.html
BSD 3-Clause "New" or "Revised" License
66 stars 34 forks source link

Separate API for computing connectivity from Epochs vs Numpy Array #65

Open adam2392 opened 2 years ago

adam2392 commented 2 years ago

Describe the problem

Many of the Connectivity functions have a long list of parameters that are used if the input data is not Epochs. However, if the input is Epochs, then a lot of this can be trimmed.

Describe your solution

Similar to how mne-python has a function to compute tfr_wavelets from both Raw and numpy arrays, we should also have a function to compute on arrays vs MNE native data structures. This will then simplify how the user will call the underlying functions and also greatly simplify the implementation of the API for any function using Epochs.

cc: @drammock @larsoner

See for example: https://mne.tools/stable/generated/mne.time_frequency.tfr_morlet.html