ENH: Add optional channel name overlay to plot_alignment#13570
ENH: Add optional channel name overlay to plot_alignment#13570drammock merged 11 commits intomne-tools:mainfrom
Conversation
aman-coder03
requested review from
agramfort,
dengemann,
drammock and
larsoner
as code owners
mne/viz/_3d.py
Outdated
| xyz[0], | ||
| xyz[1], | ||
| xyz[2], |
There was a problem hiding this comment.
| xyz[0], | |
| xyz[1], | |
| xyz[2], | |
| *xyz, |
|
@aman-coder03 please also look at our tutorials or examples that use |
|
thanks for your suggestion @drammock |
|
Hey @aman-coder03, for describing your changes in the changelog you might wanna read this. Also you can ping me if you need any sort of help. |
aman-coder03
force-pushed
the
enh-plot-alignment-channel-names
branch
from
b3694e8 to
3e575f7
Compare
|
WARNING: Docstring 'mne.viz.plot_alignment' is missing a blank line before the directive ' .. versionadded::' on line 188 The windows pip-pre failure is being tracked upstream here: statsmodels/statsmodels#9748 and we already have a work-around in #13632 so let's merge in |
drammock
left a comment
drammock
left a comment
There was a problem hiding this comment.
render looks good! https://output.circle-artifacts.com/output/job/eba2b2fd-3b82-43bd-a8d3-72eaafebe201/artifacts/0/html/auto_examples/visualization/eeg_on_scalp.html
Just a couple nitpicks.
|
🎉 Congrats on merging your first pull request! 🥳 Looking forward to seeing more from you in the future! 💪 |
|
thankyouu very much @drammock for your support and guidance!! |
3 participants
What does this PR do?
adds an optional
show_channel_namesparameter toplot_alignmentto overlay channel labels at sensor locations in the 3D alignment view.Why?
this improves interpretability when inspecting sensor alignment, especially for debugging, teaching, and demonstrations. The feature is fully opt-in and does not change default behavior.
Backward compatibility
fully backward compatible (disabled by default).
Tests
visualization tests pass (dataset-dependent tests skipped as expected).
fixes #13502