mne.make_field_map#
- mne.make_field_map(evoked, trans='auto', subject=None, subjects_dir=None, ch_type=None, mode='fast', meg_surf='helmet', origin=(0.0, 0.0, 0.04), n_jobs=None, *, upsampling=1, head_source=('bem', 'head'), verbose=None)[source]#
Compute surface maps used for field display in 3D.
- Parameters:
- evoked
Evoked|Epochs|Raw The measurement file. Need to have info attribute.
- transpath-like |
dict| instance ofTransform|"fsaverage"|None If str, the path to the head<->MRI transform
*-trans.fiffile produced during coregistration. Can also be'fsaverage'to use the built-in fsaverage transformation. If trans is None, an identity matrix is assumed."auto"(default) will load trans from the FreeSurfer directory specified bysubjectandsubjects_dirparameters.Changed in version 0.19: Support for
'fsaverage'argument.- subject
str|None The subject name corresponding to FreeSurfer environment variable SUBJECT. If None, map for EEG data will not be available.
- subjects_dirpath-like
The path to the freesurfer subjects reconstructions. It corresponds to Freesurfer environment variable SUBJECTS_DIR.
- ch_type
None|'eeg'|'meg' If None, a map for each available channel type will be returned. Else only the specified type will be used.
- mode
'accurate'|'fast' Either
'accurate'or'fast', determines the quality of the Legendre polynomial expansion used.'fast'should be sufficient for most applications.- meg_surf‘helmet’ | ‘head’
Should be
'helmet'or'head'to specify in which surface to compute the MEG field map. The default value is'helmet'.- originarray_like, shape (3,) | ‘auto’
Origin of the sphere in the head coordinate frame and in meters. Can be
'auto', which means a head-digitization-based origin fit. Default is(0., 0., 0.04).New in v0.11.
- n_jobs
int|None The number of jobs to run in parallel. If
-1, it is set to the number of CPU cores. Requires thejoblibpackage.None(default) is a marker for ‘unset’ that will be interpreted asn_jobs=1(sequential execution) unless the call is performed under ajoblib.parallel_configcontext manager that sets another value forn_jobs.- upsampling
int The upsampling factor to use for the helmet mesh. The default (1) does no upsampling. Larger integers lead to more densely sampled helmet surfaces, and the number of vertices increases as a factor of
4**(upsampling-1).New in v1.10.
- head_source
str|listofstr Head source(s) to use. See the
sourceoption ofmne.get_head_surf()for more information.New in v1.1.
- verbosebool |
str|int|None Control verbosity of the logging output. If
None, use the default verbosity level. See the logging documentation andmne.verbose()for details. Should only be passed as a keyword argument.
- evoked
- Returns:
- surf_maps
list The surface maps to be used for field plots. The list contains separate ones for MEG and EEG (if both MEG and EEG are present).
- surf_maps
