This documentation is for development version 0.18.dev0.

mne.read_epochs_kit

mne.read_epochs_kit(input_fname, events, event_id=None, mrk=None, elp=None, hsp=None, allow_unknown_format=False, verbose=None)[source]

Reader function for KIT epochs files.

Parameters:
input_fname : str

Path to the sqd file.

events : array, shape (n_events, 3)

The events typically returned by the read_events function. If some events don’t match the events of interest as specified by event_id, they will be marked as ‘IGNORED’ in the drop log.

event_id : int | list of int | dict | None

The id of the event 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 with and a dict is created with string integer names corresponding to the event id integers.

mrk : None | str | array_like, shape (5, 3) | list of str or array_like

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.

elp : None | str | array_like, shape (8, 3)

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.

hsp : None | str | array, shape (n_points, 3)

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.

verbose : bool, str, int, or None

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

Returns:
epochs : instance of Epochs

The epochs.

Notes

New in version 0.9.0.