mne.io.read_raw_ant#
- mne.io.read_raw_ant(fname, eog=None, misc='BIP\\d+', bipolars=None, impedance_annotation='impedance', *, preload=False, verbose=None) RawANT [source]#
Reader for Raw ANT files in .cnt format.
- Parameters:
- fnamefile-like
Path to the ANT raw file to load. The file should have the extension
.cnt
.- eog
str
|None
Regex pattern to find EOG channel labels. If None, no EOG channels are automatically detected.
- misc
str
|None
Regex pattern to find miscellaneous channels. If None, no miscellaneous channels are automatically detected. The default pattern
"BIP\d+"
will mark all bipolar channels asmisc
.Note
A bipolar channel might actually contain ECG, EOG or other signal types which might have a dedicated channel type in MNE-Python. In this case, use
mne.io.Raw.set_channel_types()
to change the channel type of the channel.- bipolars
list
ofstr
|tuple
ofstr
|None
The list of channels to treat as bipolar EEG channels. Each element should be a string of the form
'anode-cathode'
or in ANT terminology as'label- reference'
. If None, all channels are interpreted as'eeg'
channels referenced to the same reference electrode. Bipolar channels are treated as EEG channels with a special coil type in MNE-Python, see alsomne.set_bipolar_reference()
Warning
Do not provide auxiliary channels in this argument, provide them in the
eog
andmisc
arguments.- impedance_annotation
str
The string to use for impedance annotations. Defaults to
"impedance"
, however, the impedance measurement might mark the end of a segment and the beginning of a new segment, in which case a discontinuity similar to whatmne.concatenate_raws()
produces is present. In this case, it’s better to include aBAD_xxx
annotation to mark the discontinuity.Note
Note that the impedance annotation will likely have a duration of
0
. If the measurement marks a discontinuity, the duration should be modified to cover the discontinuity in its entirety.- preloadbool or
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).
- verbosebool |
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
RawANT
A Raw object containing ANT data. See
mne.io.Raw
for documentation of attributes and methods.
- rawinstance of
Examples using mne.io.read_raw_ant
#
Getting impedances from raw files