mne.io.read_raw_nsx#

mne.io.read_raw_nsx(input_fname, stim_channel=True, eog=None, misc=None, preload=False, *, verbose=None)[source]#

Reader function for NSx (Blackrock Microsystems) files.

Parameters:

input_fnamestr: Path to the NSx file.
stim_channel'auto' | str | list of str | int | list of int: Defaults to 'auto', which means that channels named 'status' or 'trigger' (case insensitive) are set to STIM. If str (or list of str), all channels matching the name(s) are set to STIM. If int (or list of ints), channels corresponding to the indices are set to STIM.
eoglist or tuple: Names of channels or list of indices that should be designated EOG channels. Values should correspond to the electrodes in the file. Default is None.
misclist or tuple: Names of channels or list of indices that should be designated MISC channels. Values should correspond to the electrodes in the file. Default is None.
preloadbool or str (default False): 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).
verbosebool | str | int | None: Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns:

rawinstance of RawEDF: The raw instance. See mne.io.Raw for documentation of attributes and methods.

Notes

NSx files with id (= NEURALSG), i.e., version 2.1 is currently not supported.

If channels named ‘status’ or ‘trigger’ are present, they are considered as STIM channels by default. Use func:mne.find_events to parse events encoded in such analog stim channels.