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.
- response_trig_shift : int | None
An integer that will be added to all response triggers when reading
events (stimulus triggers will be unaffected). Use
trig_shift_by_type={'response': ...} instead. If None, response
triggers will be ignored. Default is 0 for backwards compatibility,
but typically another value or None will be necessary.
This was deprecated in 0.17 and will be removed in 0.18.
- event_id : dict | None
Special events to consider in addition to those that follow the normal
BrainVision trigger format (‘###’ with an optional single character
prefix). If dict, the keys will be mapped to trigger values on the
stimulus channel. Example: {‘SyncStatus’: 1, ‘Pulse Artifact’: 3}.
If None or an empty dict (default), only BrainVision format events are
added to the stimulus channel. Keys are case sensitive. “New Segment”
markers are always dropped.
This was deprecated in 0.17 and will be removed in 0.18.
- trig_shift_by_type : dict | None
The names of marker types to which an offset should be added.
If dict, the keys specify marker types (case is ignored), so that the
corresponding value (an integer) will be added to the trigger value of
all events of this type. If the value for a key is in the dict is None,
all markers of this type will be ignored. If None (default), no offset
is added, which may lead to different marker types being mapped to the
same event id.
This was deprecated in 0.17 and will be removed in 0.18.
- stim_channel : bool (default True)
Add a stim channel from the events.
Warning
This defaults to True in 0.17 but will change to False in
0.18 (when no stim channel synthesis will be allowed)
and be removed in 0.19; migrate code to use
mne.events_from_annotations() instead.
- verbose : bool, str, int, or None
If not None, override default verbose level (see mne.verbose()
and Logging documentation for more).
|