File Formats icon Muse File Formats | MATLAB Files

Overview

This page documents the format of Muse MATLAB files (generated by MusePlayer) after they have been loaded into MATLAB. It does not detail the particulars of the .mat format itself.

All the data contained in this file corresponds to data emitted by MuseIO. Please see MuseIO’s Available Data page for descriptions.

Muse MATLAB files contain four high-level data structures:

  • IXDATA – raw data such as EEG, accelerometer, and battery level.
  • config – configuration parameters such as preset used, sampling rate, etc.
  • device – device version and settings information, such as hardware version.
  • elements – Muse Elements processed values. Includes FFT coefficients, band powers, classifier outputs, etc.

IXDATA

EEG

IXDATA.raw.eeg.data – eeg in microvolts.
IXDATA.raw.eeg.times — times of sample in unix timestamp.
IXDATA.raw.eeg.quanitization – amount quantized during lossy compression due to large data swings.
IXDATA.raw.eeg.quantization_times – timestamp of data effected by quantization, 16 samples following quantization.
IXDATA.raw.eeg.dropped – eeg dropped due to connection issues.
IXDATA.raw.eeg.dropped_times – eeg dropped times in unix timestamps

Accelerometer

IXDATA.raw.acc.data — accelerometer in milliG’s.
IXDATA.raw.acc. times — accelerometer times of samples in unix timestamp
IXDATA.raw.acc.dropped — accelerometer dropped due to connection issues.
IXDATA.raw.acc.dropped_times — accelerometer dropped times in unix timestamps

DRL and Reference

IXDATA.raw.drlref.data – drl and reference values, sampled at 10Hz
IXDATA.raw.drlref.times – drl and reference times in unix timestamps.

Battery

IXDATA.raw.battery.val – battery percent times 100, voltages measured by battery gauge, voltages measured by adc, temperature on the right side of board.
IXDATA.raw.battery.times – values timestamp in unix timestamp, should be once every 10 seconds.

Config Data

config.acc_conversion_factor
config.acc_data_enabled
config.acc_sample_frequency_hz
config.acc_units
config.afe_gain
config.battery_data_enabled
config.battery_millivolts
config.battery_percent_remaining
config.build_number
config.compression_enabled
config.drlref_conversion_factor
config.drlref_data_enabled
config.drlref_sample_frequency_hz
config.eeg_channel_count
config.eeg_channel_layou
config.eeg_conversion_factor
config.eeg_downsample
config.eeg_locations
config.eeg_output_frequency_hz
config.eeg_sample_frequency_hz
config.eeg_samples_bitwidth
config.eeg_units
config.error_data_enabled
config.filters_enabled
config.firmware_bootloader_version
config.firmware_headset_version
config.firmware_type
config.hardware_version
config.mac_addr
config.notch_frequency_hz
config.preset
config.protocol_version
config.serial_number

Device Settings

The device variable is an optional input defined by users of .muse file format. MuseLab does not save anything into this field on default, but if it receives the correct OSC message, MusePlayer will parse and populate the following data when found.
device.bluetooth_version
device.hardware_model_id
device.hardware_model_name
device.memory_size
device.number_of_processors
device.os_type
device.os_version
device.processor_name
device.processor_speed
device.time_zone
device.time_zone_offset_seconds

Muse Elements Data

elements.raw_fft0
elements.raw_fft1
elements.raw_fft2
elements.raw_fft3
elements.alpha_absolute
elements.alpha_relative
elements.alpha_session_score
elements.beta_absolute
elements.beta_relative
elements.beta_session_score
elements.delta_absolute
elements.delta_relative
elements.delta_session_score
elements.gamma_absolute
elements.gamma_relative
elements.gamma_session_score
elements.theta_absolute
elements.theta_relative
elements.theta_session_score
elements.low_freqs_absolute
elements.experimental_concentration
elements.experimental_mellow
elements.horseshoe
elements.is_good
elements.jaw_clench
elements.touching_forehead

Markers from MuseLab

MuseLab can mark instances in time when an event happens or mark a range of time when an event begins and ends. When MuseLab saves a recording, it also saves these markers. These markers are also imported into the MATLAB file when converted.
Instance markers:
IXDATA.m_struct.i_names — the names of the markers without a range or instances as strings or character arrays
IXDATA.m_struct.i_times — the times of the markers without a range or instances in unix timestamps
Range markers (markers with a start and stop time):
IXDATA.m_struct.m_names — the names of the markers with a range as strings or character arrays
IXDATA.m_struct.m_times — the marker times with a range in unix timestamps and start/stop indicators. 0 is a start, 1 is a stop.