DOC: Example using Vertexselect with source index - #14169
Open
Gnefil wants to merge 14 commits into
Open
Conversation
Co-authored-by: Marijn van Vliet <w.m.vanvliet@gmail.com>
8 tasks
Gnefil
marked this pull request as ready for review
August 20, 2026 14:12
Gnefil
requested review from
agramfort,
drammock and
wmvanvliet
as code owners
August 20, 2026 14:13
There was a problem hiding this comment.
Pull request overview
This PR enhances the UI events tutorial by adding a concrete, end-to-end example demonstrating how to react to VertexSelect events using the source_id payload (for indexing source-space–aligned data like forward-model gain matrices). It also includes a small internal adjustment in Brain picking logic related to computing the selected source index.
Changes:
- Add a new tutorial section showing how to subscribe to
"vertex_select"and useevent.source_idto drive a topomap. - Adjust volume picking code in
mne.viz.Brainto use asource_idvariable when determining the selected point. - Add a changelog fragment for the documentation update.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| tutorials/visualization/20_ui_events.py | Adds a VertexSelect usage example that indexes a forward gain matrix via source_id. |
| mne/viz/_brain/_brain.py | Tweaks how the selected index is computed/named during volume picking before publishing VertexSelect. |
| doc/changes/dev/14169.other.txt | Adds a changelog entry for the new tutorial example. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reference issue (if any)
#14094
What does this implement/fix?
This enhances the documentation tutorial
20_ui_events.pyby providing an example to VertexSelect.Additional information
Continuation of PR #14126 and #14154.