ENH: Add channel names to plot_alignment (#13502) #13507
Conversation
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
mohit-malpote
requested review from
agramfort,
dengemann,
drammock and
larsoner
as code owners
larsoner
reviewed
Nov 25, 2025
Member
larsoner
left a comment
larsoner
left a comment
There was a problem hiding this comment.
Can you modify some example/tutorial where it would help to have this? Maybe:
- Modify this plot? https://mne.tools/stable/auto_tutorials/preprocessing/70_fnirs_processing.html#viewing-location-of-sensors-over-brain-surface
- Add one to https://mne.tools/stable/auto_tutorials/intro/40_sensor_locations.html ?
- Can look here to see if there are other good candidates: https://mne.tools/stable/generated/mne.viz.plot_alignment.html#examples-using-mne-viz-plot-alignment
| @@ -1,4 +1,4 @@ | |||
| """Functions to make 3D plots with M/EEG data.""" | |||
| z"""Functions to make 3D plots with M/EEG data.""" | |||
Member
There was a problem hiding this comment.
Suggested change
| z"""Functions to make 3D plots with M/EEG data.""" | |
| """Functions to make 3D plots with M/EEG data.""" |
| %(seeg)s | ||
| %(fnirs)s | ||
| .. versionadded:: 0.20 | ||
Comment on lines
+630
to
+631
| .. versionadded:: 1.x (The maintainer will finalize the version number) | ||
Member
There was a problem hiding this comment.
Suggested change
| .. versionadded:: 1.x (The maintainer will finalize the version number) | |
| .. versionadded:: 1.12.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
#13502.
What does this implement/fix?
This PR implements the ability to display channel names directly on the 3D alignment plot.
A new parameter, show_names, is added to :func:mne.viz.plot_alignment. When set to True, it renders the channel name as a text label next to the corresponding sensor location in the 3D scene.
The implementation uses renderer.text3d to place labels for all standard sensor types (MEG, EEG, ECoG, SEEG, DBS).
A unit test has been added to mne/viz/tests/test_3d.py to ensure that text actors are correctly added to the scene when the parameter is used.
Additional information
The scale of the text labels is set to be small (0.003) and the color is gray to avoid dominating the visualization.
A corresponding entry has been added to the change log using towncrier.