1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
|
# -*- coding: utf-8 -*-
import glob
import os
from os import path as op
import shutil
from pathlib import Path
import numpy as np
import pytest
from numpy.testing import assert_equal, assert_allclose
import mne
from mne import (concatenate_raws, read_bem_surfaces, read_surface,
read_source_spaces, read_bem_solution)
from mne.bem import ConductorModel, convert_flash_mris
from mne.commands import (mne_browse_raw, mne_bti2fiff, mne_clean_eog_ecg,
mne_compute_proj_ecg, mne_compute_proj_eog,
mne_coreg, mne_kit2fiff,
mne_make_scalp_surfaces, mne_maxfilter,
mne_report, mne_surf2bem, mne_watershed_bem,
mne_compare_fiff, mne_flash_bem, mne_show_fiff,
mne_show_info, mne_what, mne_setup_source_space,
mne_setup_forward_model, mne_anonymize,
mne_prepare_bem_model, mne_sys_info)
from mne.datasets import testing
from mne.io import read_raw_fif, read_info
from mne.utils import (requires_mne, requires_freesurfer,
requires_nibabel, ArgvSetter,
_stamp_to_dt, _record_warnings)
base_dir = op.join(op.dirname(__file__), '..', '..', 'io', 'tests', 'data')
raw_fname = op.join(base_dir, 'test_raw.fif')
testing_path = testing.data_path(download=False)
subjects_dir = op.join(testing_path, 'subjects')
bem_model_fname = op.join(testing_path, 'subjects',
'sample', 'bem', 'sample-320-320-320-bem.fif')
def check_usage(module, force_help=False):
"""Ensure we print usage."""
args = ('--help',) if force_help else ()
with ArgvSetter(args) as out:
try:
module.run()
except SystemExit:
pass
assert 'Usage: ' in out.stdout.getvalue()
@pytest.mark.slowtest
def test_browse_raw():
"""Test mne browse_raw."""
check_usage(mne_browse_raw)
with ArgvSetter(('--raw', raw_fname)):
with _record_warnings(): # mpl show warning
mne_browse_raw.run()
def test_what():
"""Test mne browse_raw."""
check_usage(mne_browse_raw)
with ArgvSetter((raw_fname,)) as out:
mne_what.run()
assert 'raw' == out.stdout.getvalue().strip()
def test_bti2fiff():
"""Test mne bti2fiff."""
check_usage(mne_bti2fiff)
def test_compare_fiff():
"""Test mne compare_fiff."""
check_usage(mne_compare_fiff)
def test_show_fiff():
"""Test mne compare_fiff."""
check_usage(mne_show_fiff)
with ArgvSetter((raw_fname,)):
mne_show_fiff.run()
with ArgvSetter((raw_fname, '--tag=102')):
mne_show_fiff.run()
@requires_mne
def test_clean_eog_ecg(tmp_path):
"""Test mne clean_eog_ecg."""
check_usage(mne_clean_eog_ecg)
tempdir = str(tmp_path)
raw = concatenate_raws([read_raw_fif(f)
for f in [raw_fname, raw_fname, raw_fname]])
raw.info['bads'] = ['MEG 2443']
use_fname = op.join(tempdir, op.basename(raw_fname))
raw.save(use_fname)
with ArgvSetter(('-i', use_fname, '--quiet')):
mne_clean_eog_ecg.run()
for key, count in (('proj', 2), ('-eve', 3)):
fnames = glob.glob(op.join(tempdir, '*%s.fif' % key))
assert len(fnames) == count
@pytest.mark.slowtest
@pytest.mark.parametrize('fun', (mne_compute_proj_ecg, mne_compute_proj_eog))
def test_compute_proj_exg(tmp_path, fun):
"""Test mne compute_proj_ecg/eog."""
check_usage(fun)
tempdir = str(tmp_path)
use_fname = op.join(tempdir, op.basename(raw_fname))
bad_fname = op.join(tempdir, 'bads.txt')
with open(bad_fname, 'w') as fid:
fid.write('MEG 2443\n')
shutil.copyfile(raw_fname, use_fname)
with ArgvSetter(('-i', use_fname, '--bad=' + bad_fname,
'--rej-eeg', '150')):
with _record_warnings(): # samples, sometimes
fun.run()
fnames = glob.glob(op.join(tempdir, '*proj.fif'))
assert len(fnames) == 1
fnames = glob.glob(op.join(tempdir, '*-eve.fif'))
assert len(fnames) == 1
def test_coreg():
"""Test mne coreg."""
assert hasattr(mne_coreg, 'run')
def test_kit2fiff():
"""Test mne kit2fiff."""
# Can't check
check_usage(mne_kit2fiff, force_help=True)
@pytest.mark.slowtest
@pytest.mark.ultraslowtest
@testing.requires_testing_data
def test_make_scalp_surfaces(tmp_path, monkeypatch):
"""Test mne make_scalp_surfaces."""
pytest.importorskip('nibabel')
pytest.importorskip('pyvista')
check_usage(mne_make_scalp_surfaces)
has = 'SUBJECTS_DIR' in os.environ
# Copy necessary files to avoid FreeSurfer call
tempdir = str(tmp_path)
surf_path = op.join(subjects_dir, 'sample', 'surf')
surf_path_new = op.join(tempdir, 'sample', 'surf')
os.mkdir(op.join(tempdir, 'sample'))
os.mkdir(surf_path_new)
subj_dir = op.join(tempdir, 'sample', 'bem')
os.mkdir(subj_dir)
cmd = ('-s', 'sample', '--subjects-dir', tempdir)
monkeypatch.setattr(
mne.bem, 'decimate_surface',
lambda points, triangles, n_triangles: (points, triangles))
dense_fname = op.join(subj_dir, 'sample-head-dense.fif')
medium_fname = op.join(subj_dir, 'sample-head-medium.fif')
with ArgvSetter(cmd, disable_stdout=False, disable_stderr=False):
monkeypatch.delenv('FREESURFER_HOME')
with pytest.raises(RuntimeError, match='The FreeSurfer environ'):
mne_make_scalp_surfaces.run()
shutil.copy(op.join(surf_path, 'lh.seghead'), surf_path_new)
monkeypatch.setenv('FREESURFER_HOME', tempdir)
mne_make_scalp_surfaces.run()
assert op.isfile(dense_fname)
assert op.isfile(medium_fname)
with pytest.raises(IOError, match='overwrite'):
mne_make_scalp_surfaces.run()
# actually check the outputs
head_py = read_bem_surfaces(dense_fname)
assert_equal(len(head_py), 1)
head_py = head_py[0]
head_c = read_bem_surfaces(op.join(subjects_dir, 'sample', 'bem',
'sample-head-dense.fif'))[0]
assert_allclose(head_py['rr'], head_c['rr'])
if not has:
assert 'SUBJECTS_DIR' not in os.environ
def test_maxfilter():
"""Test mne maxfilter."""
check_usage(mne_maxfilter)
with ArgvSetter(('-i', raw_fname, '--st', '--movecomp', '--linefreq', '60',
'--trans', raw_fname)) as out:
with pytest.warns(RuntimeWarning, match="Don't use"):
os.environ['_MNE_MAXFILTER_TEST'] = 'true'
try:
mne_maxfilter.run()
finally:
del os.environ['_MNE_MAXFILTER_TEST']
out = out.stdout.getvalue()
for check in ('maxfilter', '-trans', '-movecomp'):
assert check in out, check
@pytest.mark.slowtest
@testing.requires_testing_data
def test_report(tmp_path):
"""Test mne report."""
pytest.importorskip('nibabel')
check_usage(mne_report)
tempdir = str(tmp_path)
use_fname = op.join(tempdir, op.basename(raw_fname))
shutil.copyfile(raw_fname, use_fname)
with ArgvSetter(('-p', tempdir, '-i', use_fname, '-d', subjects_dir,
'-s', 'sample', '--no-browser', '-m', '30')):
with _record_warnings(): # contour levels
mne_report.run()
fnames = glob.glob(op.join(tempdir, '*.html'))
assert len(fnames) == 1
def test_surf2bem():
"""Test mne surf2bem."""
check_usage(mne_surf2bem)
@pytest.mark.timeout(900) # took ~400 sec on a local test
@pytest.mark.slowtest
@pytest.mark.ultraslowtest
@requires_nibabel()
@requires_freesurfer('mri_watershed')
@testing.requires_testing_data
def test_watershed_bem(tmp_path):
"""Test mne watershed bem."""
check_usage(mne_watershed_bem)
# from T1.mgz
Mdc = np.array([[-1, 0, 0], [0, 0, -1], [0, 1, 0]])
Pxyz_c = np.array([-5.273613, 9.039085, -27.287964])
# Copy necessary files to tempdir
tempdir = str(tmp_path)
mridata_path = op.join(subjects_dir, 'sample', 'mri')
subject_path_new = op.join(tempdir, 'sample')
mridata_path_new = op.join(subject_path_new, 'mri')
os.makedirs(mridata_path_new)
new_fname = op.join(mridata_path_new, 'T1.mgz')
shutil.copyfile(op.join(mridata_path, 'T1.mgz'), new_fname)
old_mode = os.stat(new_fname).st_mode
os.chmod(new_fname, 0)
args = ('-d', tempdir, '-s', 'sample', '-o')
with pytest.raises(PermissionError, match=r'read permissions.*T1\.mgz'):
with ArgvSetter(args):
mne_watershed_bem.run()
os.chmod(new_fname, old_mode)
for s in ('outer_skin', 'outer_skull', 'inner_skull'):
assert not op.isfile(op.join(subject_path_new, 'bem', '%s.surf' % s))
with ArgvSetter(args):
mne_watershed_bem.run()
kwargs = dict(rtol=1e-5, atol=1e-5)
for s in ('outer_skin', 'outer_skull', 'inner_skull'):
rr, tris, vol_info = read_surface(op.join(subject_path_new, 'bem',
'%s.surf' % s),
read_metadata=True)
assert_equal(len(tris), 20480)
assert_equal(tris.min(), 0)
assert_equal(rr.shape[0], tris.max() + 1)
# compare the volume info to the mgz header
assert_allclose(vol_info['xras'], Mdc[0], **kwargs)
assert_allclose(vol_info['yras'], Mdc[1], **kwargs)
assert_allclose(vol_info['zras'], Mdc[2], **kwargs)
assert_allclose(vol_info['cras'], Pxyz_c, **kwargs)
@pytest.mark.timeout(180) # took ~70 sec locally
@pytest.mark.slowtest
@pytest.mark.ultraslowtest
@requires_freesurfer
@testing.requires_testing_data
def test_flash_bem(tmp_path):
"""Test mne flash_bem."""
check_usage(mne_flash_bem, force_help=True)
# Copy necessary files to tempdir
tempdir = Path(str(tmp_path))
mridata_path = Path(subjects_dir) / 'sample' / 'mri'
subject_path_new = tempdir / 'sample'
mridata_path_new = subject_path_new / 'mri'
flash_path = mridata_path_new / 'flash'
flash_path.mkdir(parents=True, exist_ok=True)
bem_path = mridata_path_new / 'bem'
bem_path.mkdir(parents=True, exist_ok=True)
shutil.copyfile(op.join(mridata_path, 'T1.mgz'),
op.join(mridata_path_new, 'T1.mgz'))
shutil.copyfile(op.join(mridata_path, 'brain.mgz'),
op.join(mridata_path_new, 'brain.mgz'))
# Copy the available mri/flash/mef*.mgz files from the dataset
for kind in (5, 30):
in_fname = mridata_path / "flash" / f'mef{kind:02d}.mgz'
in_fname_echo = flash_path / f'mef{kind:02d}_001.mgz'
shutil.copyfile(in_fname, flash_path / in_fname_echo.name)
# Test mne flash_bem with --noconvert option
# (since there are no DICOM Flash images in dataset)
for s in ('outer_skin', 'outer_skull', 'inner_skull'):
assert not op.isfile(subject_path_new / 'bem' / f'{s}.surf')
# First test without flash30
with ArgvSetter(('-d', tempdir, '-s', 'sample', '-n', '-r', '-3'),
disable_stdout=False, disable_stderr=False):
mne_flash_bem.run()
for s in ('outer_skin', 'outer_skull', 'inner_skull'):
surf_path = subject_path_new / 'bem' / f'{s}.surf'
assert surf_path.exists()
surf_path.unlink() # cleanup
shutil.rmtree(flash_path / "parameter_maps") # remove old files
# Test synthesize flash5 with MEF flash5 and flash30 default locations
flash5_img = convert_flash_mris(
subject="sample", subjects_dir=tempdir, unwarp=False
)
assert flash5_img == (flash_path / "parameter_maps" / "flash5.mgz")
assert flash5_img.exists()
shutil.rmtree(flash_path / "parameter_maps") # remove old files
# Test with flash5 and flash30
shutil.rmtree(flash_path) # first remove old files
with ArgvSetter(('-d', tempdir, '-s', 'sample', '-n',
'-3', str(mridata_path / "flash" / 'mef30.mgz'),
'-5', str(mridata_path / "flash" / 'mef05.mgz')),
disable_stdout=False, disable_stderr=False):
mne_flash_bem.run()
kwargs = dict(rtol=1e-5, atol=1e-5)
for s in ('outer_skin', 'outer_skull', 'inner_skull'):
rr, tris = read_surface(op.join(subject_path_new, 'bem',
'%s.surf' % s))
assert_equal(len(tris), 5120)
assert_equal(tris.min(), 0)
assert_equal(rr.shape[0], tris.max() + 1)
# compare to the testing flash surfaces
rr_c, tris_c = read_surface(op.join(subjects_dir, 'sample', 'bem',
'%s.surf' % s))
assert_allclose(rr, rr_c, **kwargs)
assert_allclose(tris, tris_c, **kwargs)
@testing.requires_testing_data
def test_setup_source_space(tmp_path):
"""Test mne setup_source_space."""
check_usage(mne_setup_source_space, force_help=True)
# Using the sample dataset
use_fname = op.join(tmp_path, "sources-src.fif")
# Test command
with ArgvSetter(('--src', use_fname, '-d', subjects_dir,
'-s', 'sample', '--morph', 'sample',
'--add-dist', 'False', '--ico', '3', '--verbose')):
mne_setup_source_space.run()
src = read_source_spaces(use_fname)
assert len(src) == 2
with pytest.raises(Exception):
with ArgvSetter(('--src', use_fname, '-d', subjects_dir,
'-s', 'sample', '--ico', '3', '--oct', '3')):
assert mne_setup_source_space.run()
with pytest.raises(Exception):
with ArgvSetter(('--src', use_fname, '-d', subjects_dir,
'-s', 'sample', '--ico', '3', '--spacing', '10')):
assert mne_setup_source_space.run()
with pytest.raises(Exception):
with ArgvSetter(('--src', use_fname, '-d', subjects_dir,
'-s', 'sample', '--ico', '3', '--spacing', '10',
'--oct', '3')):
assert mne_setup_source_space.run()
@pytest.mark.slowtest
@testing.requires_testing_data
def test_setup_forward_model(tmp_path):
"""Test mne setup_forward_model."""
check_usage(mne_setup_forward_model, force_help=True)
# Using the sample dataset
use_fname = op.join(tmp_path, "model-bem.fif")
# Test command
with ArgvSetter(('--model', use_fname, '-d', subjects_dir, '--homog',
'-s', 'sample', '--ico', '3', '--verbose')):
mne_setup_forward_model.run()
model = read_bem_surfaces(use_fname)
assert len(model) == 1
sol_fname = op.splitext(use_fname)[0] + '-sol.fif'
read_bem_solution(sol_fname)
@pytest.mark.slowtest
@testing.requires_testing_data
def test_mne_prepare_bem_model(tmp_path):
"""Test mne setup_source_space."""
check_usage(mne_prepare_bem_model, force_help=True)
# Using the sample dataset
bem_solution_fname = op.join(tmp_path, "bem_solution-bem-sol.fif")
# Test command
with ArgvSetter(('--bem', bem_model_fname, '--sol', bem_solution_fname,
'--verbose')):
mne_prepare_bem_model.run()
bem_solution = read_bem_solution(bem_solution_fname)
assert isinstance(bem_solution, ConductorModel)
def test_show_info():
"""Test mne show_info."""
check_usage(mne_show_info)
with ArgvSetter((raw_fname,)):
mne_show_info.run()
def test_sys_info():
"""Test mne show_info."""
check_usage(mne_sys_info, force_help=True)
with ArgvSetter((raw_fname,)):
with pytest.raises(SystemExit, match='1'):
mne_sys_info.run()
with ArgvSetter() as out:
mne_sys_info.run()
assert 'numpy' in out.stdout.getvalue()
def test_anonymize(tmp_path):
"""Test mne anonymize."""
check_usage(mne_anonymize)
out_fname = op.join(tmp_path, 'anon_test_raw.fif')
with ArgvSetter(('-f', raw_fname, '-o', out_fname)):
mne_anonymize.run()
info = read_info(out_fname)
assert op.exists(out_fname)
assert info['meas_date'] == _stamp_to_dt((946684800, 0))
|