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
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.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_fnamepath-like
Path to the processed data file (PDF).
- config_fnamepath-like
Path to system config file.
- head_shape_fnamepath-like |
None
Path to the head shape file.
- rotation_x
float
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.
- convert
bool
Convert to Neuromag coordinates or not.
- rename_channels
bool
Whether to keep original 4D channel labels or not. Defaults to True.
- sort_by_ch_name
bool
Reorder channels according to channel label. 4D channels don’t have monotonically increasing numbers in their labels. Defaults to True.
- ecg_ch
str
|None
The 4D name of the ECG channel. If None, the channel will be treated as regular EEG channel.
- eog_ch
tuple
ofstr
|None
The 4D names of the EOG channels. If None, the channels will be treated as regular EEG channels.
- preload
bool
orstr
(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).
New in version 0.11.
- verbose
bool
|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 RawBTi
A Raw object containing BTI data. See
mne.io.Raw
for documentation of attributes and methods.
See also
mne.io.Raw
Documentation of attributes and methods of RawBTi.
Examples using mne.io.read_raw_bti
#
4D Neuroimaging/BTi phantom dataset tutorial
Plotting sensor layouts of MEG systems