mne.read_epochs_kit#
- mne.read_epochs_kit(input_fname, events, event_id=None, mrk=None, elp=None, hsp=None, allow_unknown_format=False, standardize_names=False, verbose=None)[source]#
Reader function for Ricoh/KIT epochs files.
- Parameters:
- input_fnamepath-like
Path to the SQD file.
- events
array
ofint
, shape (n_events, 3) | path-like The array of events. The first column contains the event time in samples, with first_samp included. The third column contains the event id. If a path, must yield a
.txt
file containing the events. If some events don’t match the events of interest as specified byevent_id
, they will be marked asIGNORED
in the drop log.- event_id
int
|list
ofint
|dict
|None
The id of the events to consider. If dict, the keys can later be used to access associated events. Example: dict(auditory=1, visual=3). If int, a dict will be created with the id as string. If a list, all events with the IDs specified in the list are used. If None, all events will be used and a dict is created with string integer names corresponding to the event id integers.
- mrkpath-like |
array
of shape (5, 3) |list
|None
Marker points representing the location of the marker coils with respect to the MEG sensors, or path to a marker file. If list, all of the markers will be averaged together.
- elppath-like |
array
of shape (8, 3) |None
Digitizer points representing the location of the fiducials and the marker coils with respect to the digitized head shape, or path to a file containing these points.
- hsppath-like |
array
of shape (n_points, 3) |None
Digitizer head shape points, or path to head shape file. If more than 10,000 points are in the head shape, they are automatically decimated.
- allow_unknown_format
bool
Force reading old data that is not officially supported. Alternatively, read and re-save the data with the KIT MEG Laboratory application.
- standardize_names
bool
If True, standardize MEG and EEG channel names to be
'MEG ###'
and'EEG ###'
. If False (default), native channel names in the file will be used when possible.- verbose
bool
|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.
- Returns:
- epochsinstance of
Epochs
The epochs.
- epochsinstance of
Notes
New in version 0.9.0.