mne.io.read_raw_kit#
- mne.io.read_raw_kit(input_fname, mrk=None, elp=None, hsp=None, stim='>', slope='-', stimthresh=1, preload=False, stim_code='binary', allow_unknown_format=False, standardize_names=False, verbose=None)[source]#
Reader function for Ricoh/KIT conversion to FIF.
- Parameters
- input_fnamepath-like
Path to the SQD file.
- mrkpath-like |
arrayof 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 |
arrayof 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 |
arrayof 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.
- stim
listofint|'<'|'>'|None Channel-value correspondence when converting KIT trigger channels to a Neuromag-style stim channel. For
'<', the largest values are assigned to the first channel (default). For'>', the largest values are assigned to the last channel. Can also be specified as a list of trigger channel indexes. If None, no synthesized channel is generated.- slope
'+'|'-' How to interpret values on KIT trigger channels when synthesizing a Neuromag-style stim channel. With
'+', a positive slope (low-to-high) is interpreted as an event. With'-', a negative slope (high-to-low) is interpreted as an event.- stimthresh
float|None The threshold level for accepting voltage changes in KIT trigger channels as a trigger event. If None, stim must also be set to None.
- preload
boolorstr(defaultFalse) Preload data into memory for data manipulation and faster indexing. If True, the data will be preloaded into memory (fast, requires large amount of memory). If preload is a string, preload is the file name of a memory-mapped file which is used to store the data on the hard drive (slower, requires less memory).
- stim_code
'binary'|'channel' How to decode trigger values from stim channels.
'binary'read stim channel events as binary code, ‘channel’ encodes channel number.- 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
- rawinstance of RawKIT
A Raw object containing KIT data. See
mne.io.Rawfor documentation of attributes and methods.
See also
mne.io.RawDocumentation of attributes and methods of RawKIT.
Notes
elpandhspare usually the exported text files (*.txt) from the Polhemus FastScan system.hsprefers to the headshape surface points.elprefers to the points in head-space that corresponds to the HPI points.If
mrk,hsporelpare array_like inputs, then the numbers in xyz coordinates should be in units of meters.