mne-tools / mne-tools/mne-python

ENH: Interactive MNE report for IC selection

Open
#6,002 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
3.5k
Forks
1.6k
Avg merge
1d 6h
Merged PRs (30d)
100

Description

Describe the problem

Selecting ICA components is sometimes a complex process that requires viewing IC time series, spectral properties, topography, variance, etc. Every plot also takes time to build, so the interactive approach has a high component of waiting.

Describe your solution

I solved this by taking advantage of the MNE report, and created one with all the components' plots. In order to make the selection process easier, I added JavaScript code that adds buttons and option buttons to select the component to reject, and when done, download a JSON file.

My use case is quite general, although the use of a JSON file needs to be discussed (although it should not be up to the user to remember the numbers!).

The report needs some aesthetic tweaks, but it does it job for now.

Additional context

Code to create report: https://github.com/fraimondo/eeg_cleaner/blob/master/cleaner/report.py
Example of a report: https://www.dropbox.com/s/oq9u5heyqrem06v/LS103_LGMM_3%2020170504%201056-icm-lg_mm-egi-epo-ica.html?dl=0

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 reviewing the linked cleaner/report.py implementation and the example HTML report to understand the proposed interactive component-selection workflow. The scope still needs decisions around report aesthetics, the selection controls, and whether JSON is the appropriate output; done would mean an integrated MNE report supporting component plots, selection, and an exportable result.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, python
Domain
data-visualization, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.