mne.export.export_evokeds_mff#

mne.export.export_evokeds_mff(fname, evoked, history=None, *, overwrite=False, verbose=None)[source]#

Export evoked dataset to MFF.

Warning

Since we are exporting to external formats, there’s no guarantee that all the info will be preserved in the external format. See Notes for details.

Parameters:

fnamestr: Name of the output file.
evokedlist of Evoked instances: List of evoked datasets to export to one file. Note that the measurement info from the first evoked instance is used, so be sure that information matches.
historyNone (default) | list of dict: Optional list of history entries (dictionaries) to be written to history.xml. This must adhere to the format described in mffpy.xml_files.History.content. If None, no history.xml will be written.
overwritebool: If True (default False), overwrite the destination file if it exists.

New in version 0.24.1.
verbosebool | str | int | None: Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Notes

New in version 0.24.

Export to external format may not preserve all the information from the instance. To save in native MNE format (.fif) without information loss, use mne.Evoked.save() instead. Export does not apply projector(s). Unapplied projector(s) will be lost. Consider applying projector(s) before exporting with mne.Evoked.apply_proj().

Only EEG channels are written to the output file. info['device_info']['type'] must be a valid MFF recording device (e.g. ‘HydroCel GSN 256 1.0’). This field is automatically populated when using MFF read functions.