NeuroTechX / NeuroTechX/moabb

Allow `paradigm.get_data()` to return non-loaded Epochs

Open
#430 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

medium moabb
Dominant language
Python
Stars
1.1k
Forks
264
Avg merge
1d 13m
Merged PRs (30d)
23

Description

Since PR #408, we theoretically have the possibility to return non-loaded (i.e. preload=False) epochs and raws from the cache. However, because the paradigms' get_data concatenates epochs, they are loaded anyway by mne (see https://mne.tools/stable/generated/mne.concatenate_epochs.html).

It would be nice to have the option to get non-concatenated epochs out of a paradigm. Maybe paradigm.get_data(..., concatenate=False), or another change in the API?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the paradigms' get_data implementations and the behavior of mne.concatenate_epochs. Determine how an API option could preserve non-loaded, non-concatenated Epochs and Raws without forcing them to load. Done means the selected behavior is exposed consistently and covered by tests showing preload=False data remains non-loaded.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.