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 ofMontage
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
ortuple
ofstr
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
ortuple
ofstr
| ‘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.
- preloadbool
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.
- verbosebool,
str
,int
, orNone
If not None, override default verbose level (see
mne.verbose()
and Logging documentation for more).
- vhdr_fname
- Returns
- rawinstance of RawBrainVision
A Raw object containing BrainVision data.
See also
mne.io.Raw
Documentation of attribute and methods.