mne.io.read_raw_ant

mne.io.read_raw_ant(fname, eog=None, misc='BIP\\d+', bipolars=None, impedance_annotation='impedance', *, encoding: str = 'latin-1', preload=False, verbose=None) → RawANT

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.

eogstr | None

Regex pattern to find EOG channel labels. If None, no EOG channels are automatically detected.

miscstr | 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 as misc.

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.

bipolarslist of str | tuple of str | 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 also mne.set_bipolar_reference()

Warning

Do not provide auxiliary channels in this argument, provide them in the eog and misc arguments.

impedance_annotationstr

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 what mne.concatenate_raws() produces is present. In this case, it’s better to include a BAD_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.

encodingstr

Encoding to use for str in the CNT file. Defaults to 'latin-1'.

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 RawANT

A Raw object containing ANT data. See mne.io.Raw for documentation of attributes and methods.

Notes

New in v1.9.

Examples using mne.io.read_raw_ant

Getting impedances from raw files

Getting impedances from raw files