This documentation is for development version 0.18.dev0.

mne.io.read_raw_brainvision

mne.io.read_raw_brainvision(vhdr_fname, montage=None, eog=('HEOGL', 'HEOGR', 'VEOGb'), misc='auto', scale=1.0, preload=False, stim_channel=False, verbose=None)[source]

Reader for Brain Vision EEG file.

Parameters:
vhdr_fname : str

Path to the EEG header file.

montage : str | None | instance of Montage

Path or instance of montage containing electrode positions. If None, sensor locations are (0,0,0). See the documentation of mne.channels.read_montage() for more information.

eog : list or tuple of str

Names of channels or list of indices that should be designated EOG channels. Values should correspond to the vhdr file Default is ('HEOGL', 'HEOGR', 'VEOGb').

misc : list or tuple of str | ‘auto’

Names of channels or list of indices that should be designated MISC channels. Values should correspond to the electrodes in the vhdr file. If ‘auto’, units in vhdr file are used for inferring misc channels. Default is 'auto'.

scale : float

The scaling factor for EEG data. Unless specified otherwise by header file, units are in microvolts. Default scale factor is 1.

preload : bool

If True, all data are loaded at initialization. If False, data are not read until save.

stim_channel : False

Deprecated, will be removed in 0.19; migrate code to use mne.events_from_annotations() instead.

New in version 0.17.

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Returns:
raw : instance of RawBrainVision

A Raw object containing BrainVision data.

See also

mne.io.Raw
Documentation of attribute and methods.