Skip to content

Commit 1fb9dd6

Browse files
expose 'mode' for plotting dipole on brain (#13162)
Co-authored-by: Marijn van Vliet <w.m.vanvliet@gmail.com>
1 parent df4a3f1 commit 1fb9dd6

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

mne/viz/_brain/_brain.py

+7-2
Original file line numberDiff line numberDiff line change
@@ -2338,7 +2338,9 @@ def remove_forward(self):
23382338
self._remove("forward", render=True)
23392339

23402340
@fill_doc
2341-
def add_dipole(self, dipole, trans, colors="red", alpha=1, scales=None):
2341+
def add_dipole(
2342+
self, dipole, trans, colors="red", alpha=1, scales=None, *, mode="arrow"
2343+
):
23422344
"""Add a quiver to render positions of dipoles.
23432345
23442346
Parameters
@@ -2354,6 +2356,9 @@ def add_dipole(self, dipole, trans, colors="red", alpha=1, scales=None):
23542356
scales : list | float | None
23552357
The size of the arrow representing the dipole in
23562358
:class:`mne.viz.Brain` units. Default 5mm.
2359+
mode : "2darrow" | "arrow" | "cone" | "cylinder" | "sphere" | "oct"
2360+
The drawing mode for the dipole to render.
2361+
Defaults to ``"arrow"``.
23572362
23582363
Notes
23592364
-----
@@ -2392,7 +2397,7 @@ def add_dipole(self, dipole, trans, colors="red", alpha=1, scales=None):
23922397
*this_ori,
23932398
color=color,
23942399
opacity=alpha,
2395-
mode="arrow",
2400+
mode=mode,
23962401
scale=scale,
23972402
)
23982403
self._add_actor("dipole", actor)

mne/viz/_brain/tests/test_brain.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,9 @@ def __init__(self):
483483
ori=[[0, 1, 0]],
484484
gof=50,
485485
)
486-
brain.add_dipole(dip, fname_trans, colors="blue", scales=5, alpha=0.5)
486+
brain.add_dipole(
487+
dip, fname_trans, colors="blue", scales=5, alpha=0.5, mode="sphere"
488+
)
487489
brain.remove_dipole()
488490

489491
with pytest.raises(ValueError, match="The number of colors"):

0 commit comments

Comments
 (0)