Skip to content

MRG, ENH: Allow channel-specific annotations#8896

Merged
hoechenberger merged 3 commits intomne-tools:mainfrom
larsoner:chnames
Feb 24, 2021
Merged

MRG, ENH: Allow channel-specific annotations#8896
hoechenberger merged 3 commits intomne-tools:mainfrom
larsoner:chnames

Conversation

@larsoner
Copy link
Copy Markdown
Member

@larsoner larsoner commented Feb 22, 2021 •
edited
Loading

Closes #5507

Removes some heavy, seemingly overkill parametrization of the test_annotations.py where the parameters were only used in a single function for example. Also makes an overwrite entry in docdict.

Todo:

  • Make rename_channels change the names in annotations
  • Make drop_channels drop channel names, and channel-specific annotations that no longer apply

@larsoner larsoner added this to the 0.23 milestone Feb 22, 2021
cbrnr
cbrnr reviewed Feb 22, 2021
View reviewed changes
@larsoner larsoner changed the title MRG, ENH: Allow channel-specific annotations WIP, ENH: Allow channel-specific annotations Feb 22, 2021
@larsoner larsoner changed the title WIP, ENH: Allow channel-specific annotations MRG, ENH: Allow channel-specific annotations Feb 23, 2021
@larsoner
Copy link
Copy Markdown
Member Author

larsoner commented Feb 23, 2021

Okay I think this is good to go now

cbrnr
cbrnr reviewed Feb 23, 2021
View reviewed changes
@cbrnr
Copy link
Copy Markdown
Contributor

cbrnr commented Feb 23, 2021

LGTM +1 for merge when green!

hoechenberger
hoechenberger approved these changes Feb 23, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@hoechenberger hoechenberger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good stuff!

@hoechenberger
Copy link
Copy Markdown
Member

hoechenberger commented Feb 23, 2021

@larsoner The CI error seems unrelated to me!

@hoechenberger hoechenberger merged commit 0de802a into mne-tools:main Feb 24, 2021
@hoechenberger
Copy link
Copy Markdown
Member

hoechenberger commented Feb 24, 2021

Thank you, @larsoner!

@larsoner larsoner deleted the chnames branch February 24, 2021 13:06
This was referenced Feb 24, 2021
Closed
Open
marsipu pushed a commit to marsipu/mne-python that referenced this pull request Feb 25, 2021
@larsoner @marsipu
MRG, ENH: Allow channel-specific annotations (mne-tools#8896)
cdd332b 
* ENH: Allow channel-specific annotations

* FIX: rename, drop, example, doc

* DOC: Clarify
@jgcaffari1
Copy link
Copy Markdown

jgcaffari1 commented Nov 2, 2021 •
edited
Loading

Is this only for the most recent version of python? I do not seem to have this functionality in python 3.6 even though I am up to date with mne.

@hoechenberger
Copy link
Copy Markdown
Member

hoechenberger commented Nov 2, 2021

The latest development version and the upcoming release of MNE-Python 0.24 only support Python 3.7 and newer.

@jgcaffari1
Copy link
Copy Markdown

jgcaffari1 commented Nov 2, 2021

I have updated everything and the annotations recognize ch_names as input, but they do not actually annotate specific channels. Do the channels need to have specific names as strings?

@drammock
Copy link
Copy Markdown
Member

drammock commented Nov 2, 2021

I have updated everything and the annotations recognize ch_names as input, but they do not actually annotate specific channels. Do the channels need to have specific names as strings?

so far this feature has no effect when plotting (we plan to do that, but it's not done yet). Is that what you're noticing?

@jgcaffari1
Copy link
Copy Markdown

jgcaffari1 commented Nov 2, 2021

That is what I am noticing. Would I be able to see the channel specific annotations if I save and open in another program?

@drammock
Copy link
Copy Markdown
Member

drammock commented Nov 2, 2021

Would I be able to see the channel specific annotations if I save and open in another program?

I think SigViewer has the ability to display channel-specific annotations. I don't know if SigViewer can read our Annotations data structure (but you can export our annotations to CSV). @cbrnr would know more...

@jgcaffari1
Copy link
Copy Markdown

jgcaffari1 commented Nov 2, 2021

Thank you.

@cbrnr
Copy link
Copy Markdown
Contributor

cbrnr commented Nov 3, 2021

Yes, SigViewer should be able to import events from a CSV file with columns position, duration, channel, type, and name. A channel value of -1 means all channels. However, I just tried this with a dummy file and the import didn't work (but there was no error either), so I guess this functionality is currently broken 😢 .

@jackz314
Copy link
Copy Markdown
Contributor

jackz314 commented May 19, 2023

Just wondering if there has been any progress on displaying per-channel annotations?

@larsoner
Copy link
Copy Markdown
Member Author

larsoner commented May 19, 2023

Not that I've seen

@drammock
Copy link
Copy Markdown
Member

drammock commented May 19, 2023

Just wondering if there has been any progress on displaying per-channel annotations?

@britta-wstnr good one for the fall sprint?

@aplzr
Copy link
Copy Markdown
Contributor

aplzr commented Aug 2, 2024

Chiming in to say that I would very much appreciate this feature as well.

@aplzr
Copy link
Copy Markdown
Contributor

aplzr commented Aug 8, 2024

I just realized that visualization of channel-specific annotations has actually been implemented in mne-qt-browser, so I'm posting here again for the benefit of everyone that didn't find the respective issues and pull requests, but did find this pull request (as I had initially).

  • Install mne-qt-browser (python -m pip install mne-qt-browser)
  • Activate its qt backend 
    from mne.viz import set_browser_backend
set_browser_backend("qt")
  • Plot a RawArray that has channel-specific annotations

mneqtspindleannot

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@agramfort agramfort agramfort left review comments

@cbrnr cbrnr cbrnr left review comments

+1 more reviewer

@hoechenberger hoechenberger hoechenberger approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

0.23

Development

Successfully merging this pull request may close these issues.

Event markers per channel

8 participants

@larsoner @cbrnr @hoechenberger @jgcaffari1 @drammock @jackz314 @aplzr @agramfort