Skip to content

MRG: Refactor _get_ps_kwarg #7695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
agramfort merged 1 commit into from
Apr 29, 2020
Merged

MRG: Refactor _get_ps_kwarg #7695

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 8 additions & 28 deletions mne/viz/_3d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1885,29 +1885,6 @@ def _check_time_viewer_compatibility(brain, time_viewer, show_traces):
TimeViewer(brain, show_traces=show_traces)


def _get_ps_kwargs(initial_time, diverging, mid, transparent):
"""Triage arguments based on PySurfer version."""
import surfer
surfer_version = LooseVersion(surfer.__version__)
require = '0.8'
if surfer_version < LooseVersion(require):
raise ImportError("This function requires PySurfer %s (you are "
"running version %s). You can update PySurfer "
"using:\n\n $ pip install -U pysurfer" %
(require, surfer.__version__))

ad_kwargs = dict(verbose=False)
sd_kwargs = dict(transparent=transparent, verbose=False)
if initial_time is not None:
ad_kwargs['initial_time'] = initial_time
if surfer_version >= LooseVersion('0.9'):
ad_kwargs.update(mid=mid, transparent=transparent)
ad_kwargs['center'] = 0. if diverging else None
sd_kwargs['center'] = 0. if diverging else None

return ad_kwargs, sd_kwargs


def _glass_brain_crosshairs(params, x, y, z):
for ax, a, b in ((params['ax_y'], x, z),
(params['ax_x'], y, z),
Expand Down Expand Up @@ -2435,6 +2412,7 @@ def plot_vector_source_estimates(stc, subject=None, hemi='lh', colormap='hot',
# Import here to avoid circular imports
if get_3d_backend() == "mayavi":
from surfer import Brain
from surfer import __version__ as surfer_version
else: # PyVista
from ._brain import _Brain as Brain
from ..source_estimate import VectorSourceEstimate
Expand Down Expand Up @@ -2477,9 +2455,7 @@ def plot_vector_source_estimates(stc, subject=None, hemi='lh', colormap='hot',
for hemi in hemis if hemi in brain.geo])
scale_factor = 0.025 * width / scale_pts[-1]

ad_kwargs, sd_kwargs = _get_ps_kwargs(
initial_time, False, scale_pts[1], transparent)
del initial_time, transparent
sd_kwargs = dict(transparent=transparent, verbose=False)
for hemi in hemis:
hemi_idx = 0 if hemi == 'lh' else 1
data = getattr(stc, hemi + '_data')
Expand All @@ -2494,14 +2470,18 @@ def plot_vector_source_estimates(stc, subject=None, hemi='lh', colormap='hot',
"colorbar": colorbar,
"vector_alpha": vector_alpha,
"scale_factor": scale_factor,
"verbose": False,
}
kwargs.update(ad_kwargs)
kwargs.pop('mid', None)
if initial_time is not None:
kwargs['initial_time'] = initial_time
if get_3d_backend() == "mayavi":
if surfer_version >= LooseVersion('0.9'):
kwargs["transparent"] = transparent
kwargs["min"] = scale_pts[0]
kwargs["mid"] = scale_pts[1]
kwargs["max"] = scale_pts[2]
else:
kwargs["transparent"] = transparent
kwargs["fmin"] = scale_pts[0]
kwargs["fmid"] = scale_pts[1]
kwargs["fmax"] = scale_pts[2]
Expand Down
6 changes: 1 addition & 5 deletions mne/viz/backends/renderer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def set_3d_backend(backend_name, verbose=None):
+--------------------------------------+--------+---------+
| 3D function: | mayavi | pyvista |
+======================================+========+=========+
| :func:`plot_vector_source_estimates` | ✓ | - |
| :func:`plot_vector_source_estimates` | ✓ | ✓ |
+--------------------------------------+--------+---------+
| :func:`plot_source_estimates` | ✓ | ✓ |
+--------------------------------------+--------+---------+
Expand Down Expand Up @@ -95,10 +95,6 @@ def set_3d_backend(backend_name, verbose=None):
+--------------------------------------+--------+---------+
| Point picking | | ✓ |
+--------------------------------------+--------+---------+
| Linked cameras | | |
+--------------------------------------+--------+---------+
| Eye-dome lighting | | |
+--------------------------------------+--------+---------+

.. note::
In the case of `plot_vector_source_estimates` with PyVista, the glyph
Expand Down