mne.io.read_raw_nicolet#

mne.io.read_raw_nicolet(input_fname, ch_type, eog=(), ecg=(), emg=(), misc=(), preload=False, verbose=None)[source]#

Read Nicolet data as raw object.

Note

This reader takes data files with the extension .data as an input. The header file with the same file name stem and an extension .head is expected to be found in the same directory.

Parameters:

input_fnamepath-like: Path to the data file (ending with .data not .head).
ch_typestr: Channel type to designate to the data channels. Supported data types include 'eeg', 'dbs'.
eoglist | tuple | 'auto': Names of channels or list of indices that should be designated EOG channels. If 'auto', the channel names beginning with EOG are used. Defaults to empty tuple.
ecglist or tuple | 'auto': Names of channels or list of indices that should be designated ECG channels. If 'auto', the channel names beginning with ECG are used. Defaults to empty tuple.
emglist or tuple | 'auto': Names of channels or list of indices that should be designated EMG channels. If 'auto', the channel names beginning with EMG are used. Defaults to empty tuple.
misclist or tuple: Names of channels or list of indices that should be designated MISC channels. Defaults to empty tuple.
preloadbool | str: 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, it is the name of a freshly created memory-mapped file used to store the data on the hard drive (slower, requires less memory). An existing file is overwritten. The caller owns the file and is responsible for removing it after the Raw object is no longer in use. For supported Raw readers, the exact string "auto" instead reuses decoded data below the directory configured by mne.set_cache_dir(). Entries persist without a size limit and are mapped copy-on-write. Use Path("auto") for a literal filename.

Changed in version 1.13: Support for the "auto" decoded-data cache was added.
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 RawNicolet: A Raw object containing the data.