BUG: Force mayavi in test that uses it (#9944)

* BUG: Force mayavi in test that uses it

* BUG: Fix appearance and bug

* FIX: Geom

Author: larsoner

mne/conftest.py

@@ -418,6 +418,13 @@ def renderer_pyvistaqt(request, garbage_collect):
         yield renderer
 
 
+@pytest.fixture(params=["mayavi"])
+def renderer_mayavi(request, garbage_collect):
+    """Yield the mayavi backend."""
+    with _use_backend(request.param, interactive=False) as renderer:
+        yield renderer
+
+
 @pytest.fixture(params=["notebook"])
 def renderer_notebook(request):
     """Yield the 3D notebook renderer."""

mne/coreg.py

@@ -1413,6 +1413,7 @@ def _setup_bem(self):
     def _setup_fiducials(self, fids):
         _validate_type(fids, (str, dict, list))
         # find fiducials file
+        fid_accurate = None
         if fids == 'auto':
             fid_files = _find_fiducials_files(self._subject,
                                               self._subjects_dir)
@@ -1422,13 +1423,16 @@ def _setup_fiducials(self, fids):
                     subjects_dir=self._subjects_dir, subject=self._subject)
                 logger.info(f'Using fiducials from: {fid_filename}.')
                 fids, _ = read_fiducials(fid_filename)
+                fid_accurate = True
             else:
                 fids = 'estimated'
 
         if fids == 'estimated':
             logger.info('Estimating fiducials from fsaverage.')
+            fid_accurate = False
             fids = get_mni_fiducials(self._subject, self._subjects_dir)
 
+        fid_accurate = True if fid_accurate is None else fid_accurate
         if isinstance(fids, list):
             fid_coords = _fiducial_coords(fids)
         else:
@@ -1437,6 +1441,7 @@ def _setup_fiducials(self, fids):
                                   dtype=float)
 
         self._fid_points = fid_coords
+        self._fid_accurate = fid_accurate
 
         # does not seem to happen by itself ... so hard code it:
         self._reset_fiducials()

mne/gui/_coreg.py

@@ -117,17 +117,17 @@ def _get_default(var, val):
         self._defaults = dict(
             size=_get_default(size, (800, 600)),
             bgcolor=_get_default(bgcolor, "grey"),
-            orient_glyphs=_get_default(orient_glyphs, False),
+            orient_glyphs=_get_default(orient_glyphs, True),
             hpi_coils=_get_default(hpi_coils, True),
             head_shape_points=_get_default(head_shape_points, True),
             eeg_channels=_get_default(eeg_channels, True),
-            head_resolution=_get_default(head_resolution, False),
+            head_resolution=_get_default(head_resolution, True),
             head_transparency=_get_default(head_transparency, False),
             head_opacity=0.5,
             sensor_opacity=_get_default(sensor_opacity, 1.0),
             fiducials=("LPA", "Nasion", "RPA"),
             fiducial="LPA",
-            lock_fids=False,
+            lock_fids=True,
             grow_hair=0.0,
             scale_modes=["None", "uniform", "3-axis"],
             scale_mode="None",
@@ -162,6 +162,7 @@ def _get_default(var, val):
         self._fiducials = fiducials
         self._coreg = Coregistration(
             self._info, subject, subjects_dir, fiducials)
+        fid_accurate = self._coreg._fid_accurate
         for fid in self._defaults["weights"].keys():
             setattr(self, f"_{fid}_weight", self._defaults["weights"][fid])
 
@@ -188,13 +189,20 @@ def _get_default(var, val):
         # once the docks are initialized
         self._set_current_fiducial(self._defaults["fiducial"])
         self._set_scale_mode(self._defaults["scale_mode"])
-        self._set_lock_fids(info is not None)
         if trans is not None:
             self._load_trans(trans)
+        if not fid_accurate:
+            self._set_head_resolution('high')
+            self._set_lock_fids(True)  # hack to make the dig disappear
+        self._set_lock_fids(fid_accurate)
 
         # must be done last
         if show:
             self._renderer.show()
+        # update the view once shown
+        views = {True: dict(azimuth=90, elevation=90),  # front
+                 False: dict(azimuth=180, elevation=90)}  # left
+        self._renderer.set_camera(distance=None, **views[self._lock_fids])
         if standalone:
             self._renderer.figure.store["app"].exec()
 
@@ -343,6 +351,7 @@ def _fiducials_file_changed(self, change=None):
         fids, _ = read_fiducials(self._fiducials_file)
         self._coreg._setup_fiducials(fids)
         self._reset()
+        self._set_lock_fids(True)
 
     @observe("_current_fiducial")
     def _current_fiducial_changed(self, change=None):

mne/gui/tests/test_coreg_gui.py

@@ -171,7 +171,7 @@ def test_coreg_model(subjects_dir_tmp):
 
 @requires_mayavi
 @traits_test
-def test_coreg_gui_display(subjects_dir_tmp, check_gui_ci):
+def test_coreg_gui_display(subjects_dir_tmp, check_gui_ci, renderer_mayavi):
     """Test CoregFrame."""
     from mayavi import mlab
     from tvtk.api import tvtk
@@ -423,9 +423,12 @@ def test_coreg_gui_pyvista(tmpdir, renderer_interactive_pyvistaqt):
     config = get_config(home_dir=os.environ.get('_MNE_FAKE_HOME_DIR'))
     tmp_trans = op.join(tempdir, 'tmp-trans.fif')
 
+    # the sample subject in testing has MRI fids
+    assert op.isfile(op.join(
+        subjects_dir, 'sample', 'bem', 'sample-fiducials.fif'))
     coreg = coregistration(subject='sample', subjects_dir=subjects_dir,
                            trans=fname_trans)
-    assert not coreg._lock_fids
+    assert coreg._lock_fids
     coreg._reset_fiducials()
     coreg.close()
 

mne/viz/backends/_abstract.py

@@ -13,12 +13,18 @@
 
 
 class _AbstractRenderer(ABC):
+
     @abstractclassmethod
     def __init__(self, fig=None, size=(600, 600), bgcolor=(0., 0., 0.),
                  name=None, show=False, shape=(1, 1)):
         """Set up the scene."""
         pass
 
+    @property
+    @abstractmethod
+    def _kind(self):
+        pass
+
     @abstractclassmethod
     def subplot(self, x, y):
         """Set the active subplot."""

mne/viz/backends/_notebook.py

@@ -433,6 +433,8 @@ def update(self, repaint=True):
 
 class _Renderer(_PyVistaRenderer, _IpyDock, _IpyToolBar, _IpyMenuBar,
                 _IpyStatusBar, _IpyWindow, _IpyPlayback):
+    _kind = 'notebook'
+
     def __init__(self, *args, **kwargs):
         self._dock = None
         self._tool_bar = None

mne/viz/backends/_pysurfer_mayavi.py

@@ -61,6 +61,8 @@ class _Renderer(_AbstractRenderer):
         Mayavi scene handle.
     """
 
+    _kind = 'mayavi'
+
     def __init__(self, fig=None, size=(600, 600), bgcolor='black',
                  name=None, show=False, shape=(1, 1), smooth_shading=True):
         if bgcolor is not None:

mne/viz/backends/_qt.py

@@ -642,6 +642,8 @@ def update(self, repaint=True):
 
 class _Renderer(_PyVistaRenderer, _QtDock, _QtToolBar, _QtMenuBar,
                 _QtStatusBar, _QtWindow, _QtPlayback):
+    _kind = 'qt'
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self._window_initialize()
@@ -653,6 +655,7 @@ def show(self):
                 self.plotter.app_window.show()
         self._update()
         for plotter in self._all_plotters:
+            plotter.updateGeometry()
             plotter._render()
         self._process_events()