mne.io.read_raw_bti

mne.io.read_raw_bti(pdf_fname, config_fname='config', head_shape_fname='hs_file', rotation_x=0.0, translation=(0.0, 0.02, 0.11), convert=True, rename_channels=True, sort_by_ch_name=True, ecg_ch='E31', eog_ch=('E63', 'E64'), preload=False, verbose=None)[source]

Raw object from 4D Neuroimaging MagnesWH3600 data.

Note

  1. Currently direct inclusion of reference channel weights is not supported. Please use mne_create_comp_data to include the weights or use the low level functions from this module to include them by yourself.

  2. The informed guess for the 4D name is E31 for the ECG channel and E63, E63 for the EOG channels. Please check and adjust if those channels are present in your dataset but ‘ECG 01’ and ‘EOG 01’, ‘EOG 02’ don’t appear in the channel names of the raw object.

Parameters
pdf_fnamestr

Path to the processed data file (PDF).

config_fnamestr

Path to system config file.

head_shape_fnamestr | None

Path to the head shape file.

rotation_xfloat

Degrees to tilt x-axis for sensor frame misalignment. Ignored if convert is True.

translationarray_like, shape (3,)

The translation to place the origin of coordinate system to the center of the head. Ignored if convert is True.

convertbool

Convert to Neuromag coordinates or not.

rename_channelsbool

Whether to keep original 4D channel labels or not. Defaults to True.

sort_by_ch_namebool

Reorder channels according to channel label. 4D channels don’t have monotonically increasing numbers in their labels. Defaults to True.

ecg_chstr | None

The 4D name of the ECG channel. If None, the channel will be treated as regular EEG channel.

eog_chtuple of str | None

The 4D names of the EOG channels. If None, the channels will be treated as regular EEG channels.

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).

New in version 0.11.

verbosebool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more). If used, it should be passed as a keyword-argument only.

Returns
rawinstance of RawBTi

A Raw object containing BTI data.

See also

mne.io.Raw

Documentation of attribute and methods.

Examples using mne.io.read_raw_bti