mne.io.read_raw_cnt¶
-
mne.io.
read_raw_cnt
(input_fname, montage, eog=(), misc=(), ecg=(), emg=(), data_format='auto', date_format='mm/dd/yy', preload=False, stim_channel=None, verbose=None)[source]¶ Read CNT data as raw object.
Note
If montage is not provided, the x and y coordinates are read from the file header. Channels that are not assigned with keywords
eog
,ecg
,emg
andmisc
are assigned as eeg channels. All the eeg channel locations are fit to a sphere when computing the z-coordinates for the channels. If channels assigned as eeg channels have locations far away from the head (i.e. x and y coordinates don’t fit to a sphere), all the channel locations will be distorted. If you are not sure that the channel locations in the header are correct, it is probably safer to use a (standard) montage. Seemne.channels.read_montage()
- Parameters
- input_fname
str
Path to the data file.
- montage
str
|None
| instance ofMontage
Path or instance of montage containing electrode positions. If None, xy sensor locations are read from the header (
x_coord
andy_coord
inELECTLOC
) and fit to a sphere. See the documentation ofmne.channels.read_montage()
for more information.- eog
list
|tuple
| ‘auto’ | ‘header’ Names of channels or list of indices that should be designated EOG channels. If ‘header’, VEOG and HEOG channels assigned in the file header are used. If ‘auto’, channel names containing ‘EOG’ are used. Defaults to empty tuple.
- misc
list
|tuple
Names of channels or list of indices that should be designated MISC channels. Defaults to empty tuple.
- ecg
list
|tuple
| ‘auto’ Names of channels or list of indices that should be designated ECG channels. If ‘auto’, the channel names containing ‘ECG’ are used. Defaults to empty tuple.
- emg
list
|tuple
Names of channels or list of indices that should be designated EMG channels. If ‘auto’, the channel names containing ‘EMG’ are used. Defaults to empty tuple.
- data_format‘auto’ | ‘int16’ | ‘int32’
Defines the data format the data is read in. If ‘auto’, it is determined from the file header using
numsamples
field. Defaults to ‘auto’.- date_format‘mm/dd/yy’ | ‘dd/mm/yy’
Format of date in the header. Defaults to ‘mm/dd/yy’.
- preloadbool |
str
(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_channelbool |
None
Add a stim channel from the events. Defaults to None to trigger a future warning.
Warning
This defaults to True in 0.18 but will change to False in 0.19 (when no stim channel synthesis will be allowed) and be removed in 0.20; migrate code to use
mne.events_from_annotations()
instead.New in version 0.18.
- verbosebool,
str
,int
, orNone
If not None, override default verbose level (see
mne.verbose()
and Logging documentation for more).
- input_fname
- Returns
- rawinstance of RawCNT.
The raw data.
See also
mne.io.Raw
Documentation of attribute and methods.
Notes
New in version 0.12.