Added ICLabel to the mne-bids pipeline #3

jschepers · 2024-06-26T14:52:53Z

Before merging …

Changelog has been updated (docs/source/changes.md)

Changes

Added the code from this PR by @hoechenberger
- Comment: In the newer version of mne-bids-pipeline the ICA is divided into two scripts, therefore I had to divide the code into these scripts.
@behinger added two config variables ica_use_ecg_detection and ica_use_eog_detection to control whether MNE eog/ecg detection should be used on the ICs
We implemented that the user can specify in the config file (using the variable icalabel_include) which labels/ICs to include. Default is ["brain","other"].
- Comment: We should add tests for this e.g. No value given -> Default should be used, Empty list or wrong labels -> Error
Added plots of the excluded ICs to the report together with their labels and the probability of the labels.
- Comment: The plotting needs improvement e.g. combine all single plots in one plot

Co-authored-by: Richard Höchenberger <richard.hoechenberger@gmail.com>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Richard Höchenberger <richard.hoechenberger@gmail.com>

…is readable in light and dark theme (mne-tools#793) Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

…rameters; drop support for `loose=None` (mne-tools#915) Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

Co-authored-by: Richard Höchenberger <richard.hoechenberger@gmail.com>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

…#874)

…g from the dataset (mne-tools#928)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

…and subject or experimenter name) (mne-tools#931) Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

…tools#933)

Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

…structed ICA and SSP epochs (mne-tools#936)

mne-tools#938)

…s#937) Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

…input whether to do eog or ecg detection on ICs

hoechenberger and others added 30 commits July 4, 2023 10:11

Prepare for 1.4.0 release (mne-tools#753)

3b17158

MAINT: Cleanup dependencies and doc build (mne-tools#755)

49c2e31

ENH: Add annotation of head velocity (mne-tools#757)

4d16356

BUG: Fix bug with cache invalidation (mne-tools#756)

ccbac54

ENH: Add T1 and FLASH BEM to website (mne-tools#758)

ea37de0

BUG: Fix bug with empty room processing (mne-tools#761)

e5d5f1f

ENH: More compact logging (mne-tools#764)

721162a

Co-authored-by: Richard Höchenberger <richard.hoechenberger@gmail.com>

ENH: Add eSSS (mne-tools#762)

62dde41

ENH: Cache grand-average steps (mne-tools#765)

81d6f55

MAINT: Test MD5 hashing too (mne-tools#768)

018552e

ENH: Better logging of distances (mne-tools#769)

ea95979

MAINT: pre-commit.ci (mne-tools#774)

4b289c9

Added deriv_root argument to CLI (mne-tools#773)

721e728

Co-authored-by: Richard Höchenberger <richard.hoechenberger@gmail.com>

MAINT: Use pooch for downloading web data (mne-tools#775)

5c19b94

[pre-commit.ci] pre-commit autoupdate (mne-tools#776)

a931cae

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

API: Change default to _cache (mne-tools#778)

918cc3b

[pre-commit.ci] pre-commit autoupdate (mne-tools#780)

34350ce

ENH: Validate inputs with pydantic (mne-tools#779)

7a5d01d

TST: Rerun CIs (mne-tools#781)

866c2bb

BUG: Fix bug where individual invs were not rendered (mne-tools#782)

f512fe9

[pre-commit.ci] pre-commit autoupdate (mne-tools#784)

dad6aa9

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

[pre-commit.ci] pre-commit autoupdate (mne-tools#786)

8ee8d8d

[pre-commit.ci] pre-commit autoupdate (mne-tools#787)

e58675c

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

[pre-commit.ci] pre-commit autoupdate (mne-tools#788)

0b4bfcc

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

[pre-commit.ci] pre-commit autoupdate (mne-tools#789)

38138d3

[pre-commit.ci] pre-commit autoupdate (mne-tools#790)

5dac5cb

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

MAINT: Fix bug with item (mne-tools#791)

f781b59

[pre-commit.ci] pre-commit autoupdate (mne-tools#792)

754c85f

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Richard Höchenberger <richard.hoechenberger@gmail.com>

Ensure link in "You're not viewing the latest stable version" banner …

f99ada6

…is readable in light and dark theme (mne-tools#793) Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

[pre-commit.ci] pre-commit autoupdate (mne-tools#795)

9904fb3

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

hoechenberger and others added 30 commits April 2, 2024 12:14

Improve documentation and config validation of loose and depth pa…

6288770

…rameters; drop support for `loose=None` (mne-tools#915) Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

change default for info to use for inverse mne-tools#905 (mne-tools#919)

cbeeb98

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

ENH: Streamline ICA reporting (mne-tools#899)

856dfe2

Co-authored-by: Richard Höchenberger <richard.hoechenberger@gmail.com>

[pre-commit.ci] pre-commit autoupdate (mne-tools#923)

79e19c1

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Support variable time windows for epochs metadata creation (mne-tools…

148a785

…#874)

Raise a more helpful error message when requested subjects are missin…

04331fa

…g from the dataset (mne-tools#928)

[pre-commit.ci] pre-commit autoupdate (mne-tools#929)

a46c980

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Fix report section on original raw data (didn't contain bad channels …

a52c00c

…and subject or experimenter name) (mne-tools#931) Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

In the report TOC, don't put the run numbers in quotation marks (mne-…

ec1c8fd

…tools#933)

Rename ica_ctps_ecg_threshold to ica_ecg_threshold (mne-tools#935)

b80ed31

Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

Improve logging output when rejecting epochs; and log number of recon…

4d3a878

…structed ICA and SSP epochs (mne-tools#936)

Save ECG and EOG evokeds created during ICA artifact detection to disk (

afdf160

mne-tools#938)

Improve logging during ICA artifact discovery and rejection (mne-tool…

7e1d9f9

…s#937) Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

DOC: Fix typo (mne-tools#940)

44a884f

[pre-commit.ci] pre-commit autoupdate (mne-tools#942)

31ee24e

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

[pre-commit.ci] pre-commit autoupdate (mne-tools#945)

88b3e4f

MAINT: Cleaner hook into mkdocstrings-python (mne-tools#943)

2872b98

[pre-commit.ci] pre-commit autoupdate (mne-tools#947)

87be595

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

remove ref-names from .git_archival.txt (mne-tools#948)

0a87002

MAINT: Cleaner traceback on error (mne-tools#951)

fafdaeb

[pre-commit.ci] pre-commit autoupdate (mne-tools#953)

22192a6

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

[pre-commit.ci] pre-commit autoupdate (mne-tools#954)

3f012ff

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

[pre-commit.ci] pre-commit autoupdate (mne-tools#955)

e06956f

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

[MAINT] Switch to trusted publishing (mne-tools#957)

31f408b

[pre-commit.ci] pre-commit autoupdate (mne-tools#959)

6598017

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Rework how we apply EEG montages (mne-tools#960)

65e1aa6

[pre-commit.ci] pre-commit autoupdate (mne-tools#961)

62fd351

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

added iclabel code from PR, user input which IC labels to keep, user …

2922224

…input whether to do eog or ecg detection on ICs

use brain and other as default for icalabel_include

3338807

added rudimentary plot of excluded components + labels + probabilities

4bf3976

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Added ICLabel to the mne-bids pipeline #3

Added ICLabel to the mne-bids pipeline #3

Uh oh!

jschepers commented Jun 26, 2024 •

edited by behinger

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Added ICLabel to the mne-bids pipeline #3

Are you sure you want to change the base?

Added ICLabel to the mne-bids pipeline #3

Uh oh!

Conversation

jschepers commented Jun 26, 2024 • edited by behinger Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before merging …

Changes

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

jschepers commented Jun 26, 2024 •

edited by behinger

Loading