LibMuse 6.0.1
Public Attributes | List of all members
com.choosemuse.libmuse.MuseDataPacketType Enum Reference

Public Attributes

 ACCELEROMETER
 
 GYRO
 
 EEG
 
 DROPPED_ACCELEROMETER
 
 DROPPED_EEG
 
 QUANTIZATION
 
 BATTERY
 
 DRL_REF
 
 ALPHA_ABSOLUTE
 
 BETA_ABSOLUTE
 
 DELTA_ABSOLUTE
 
 THETA_ABSOLUTE
 
 GAMMA_ABSOLUTE
 
 ALPHA_RELATIVE
 
 BETA_RELATIVE
 
 DELTA_RELATIVE
 
 THETA_RELATIVE
 
 GAMMA_RELATIVE
 
 ALPHA_SCORE
 
 BETA_SCORE
 
 DELTA_SCORE
 
 THETA_SCORE
 
 GAMMA_SCORE
 
 IS_GOOD
 
 HSI
 
 HSI_PRECISION
 
 ARTIFACTS
 
 TOTAL
 

Detailed Description

This Enum represents all possible packet types. The type of the packet tells you information about what data it contains. When you know the packet type, look at the corresponding enum for information about data mapping (e.g.: Accelerometer enum, EEG enum, etc).

Member Data Documentation

§ ACCELEROMETER

com.choosemuse.libmuse.MuseDataPacketType.ACCELEROMETER

3-axis accelerometer data packet An Accelerometer packet provides 3 pieces of data.

See also

§ ALPHA_ABSOLUTE

com.choosemuse.libmuse.MuseDataPacketType.ALPHA_ABSOLUTE

EEG derived value. Absolute alpha band powers for each channel. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ ALPHA_RELATIVE

com.choosemuse.libmuse.MuseDataPacketType.ALPHA_RELATIVE

EEG derived value. Relative alpha band powers for each channel. Values in this packet are in range [0; 1]. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ ALPHA_SCORE

com.choosemuse.libmuse.MuseDataPacketType.ALPHA_SCORE

EEG derived value. Alpha band power scores for each channel. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ ARTIFACTS

com.choosemuse.libmuse.MuseDataPacketType.ARTIFACTS

Artifacts packet type will be sent.

Note that this will result in your listener receiving MuseArtifactPacket . We never emit a MuseDataPacket with MuseDataPacketType.ARTIFACTS ; this is only here for use in register / unregister methods.

§ BATTERY

com.choosemuse.libmuse.MuseDataPacketType.BATTERY

Muse headband battery data packet. This packet provides 3 pieces of data.

See also

§ BETA_ABSOLUTE

com.choosemuse.libmuse.MuseDataPacketType.BETA_ABSOLUTE

EEG derived value. Absolute beta band powers for each channel. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ BETA_RELATIVE

com.choosemuse.libmuse.MuseDataPacketType.BETA_RELATIVE

EEG derived value. Relative beta band powers for each channel. Values in this packet are in range [0; 1]. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ BETA_SCORE

com.choosemuse.libmuse.MuseDataPacketType.BETA_SCORE

EEG derived value. Beta band power scores for each channel. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ DELTA_ABSOLUTE

com.choosemuse.libmuse.MuseDataPacketType.DELTA_ABSOLUTE

EEG derived value. Absolute delta band powers for each channel. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ DELTA_RELATIVE

com.choosemuse.libmuse.MuseDataPacketType.DELTA_RELATIVE

EEG derived value. Relative delta band powers for each channel. Values in this packet are in range [0; 1]. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ DELTA_SCORE

com.choosemuse.libmuse.MuseDataPacketType.DELTA_SCORE

EEG derived value. Delta band power scores for each channel. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ DRL_REF

com.choosemuse.libmuse.MuseDataPacketType.DRL_REF

Packet contains raw data from Muse DRL and REF sensors. This packet provides 2 pieces of data.

See also

§ DROPPED_ACCELEROMETER

com.choosemuse.libmuse.MuseDataPacketType.DROPPED_ACCELEROMETER

Packet stands in for n dropped samples of the accelerometer type. Size of the values array for this packet is always 1.

Deprecated:
This is never emitted in an actual Muse session; instead, NaN-filled packets of the basic type (EEG or ACCELEROMETER) are emitted to stand in for dropped packets. This can only appear when reading Muse files written with older versions of the library.

§ DROPPED_EEG

com.choosemuse.libmuse.MuseDataPacketType.DROPPED_EEG

Packet stands in for n dropped samples of the eeg type. Size of the values array for this packet is always 1.

Deprecated:
This is never emitted in an actual Muse session; instead, NaN-filled packets of the basic type (EEG or ACCELEROMETER) are emitted to stand in for dropped packets. This can only appear when reading Muse files written with older versions of the library.

§ EEG

com.choosemuse.libmuse.MuseDataPacketType.EEG

Specifies raw EEG samples.

Values in this packet correspond to EEG data read from the different sensor locations on the headband. The accessors in the Eeg enum define the mapping from packet values to sensor locations.

The size of the data is unspecified, but it is large enough to hold all the EEG channels emitted by the current preset. In the current version of the library, it is never more than 6 elements long, i.e. it always fits into a 6-element array.

In the future new Muse Presets may be added, which will have extra values.

See also
  • Eeg for mapping details.

§ GAMMA_ABSOLUTE

com.choosemuse.libmuse.MuseDataPacketType.GAMMA_ABSOLUTE

EEG derived value. Absolute gamma band powers for each channel. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ GAMMA_RELATIVE

com.choosemuse.libmuse.MuseDataPacketType.GAMMA_RELATIVE

EEG derived value. Relative band powers for each channel. Values in this packet are in range [0; 1]. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ GAMMA_SCORE

com.choosemuse.libmuse.MuseDataPacketType.GAMMA_SCORE

EEG derived value. Gamma band power scores for each channel. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ GYRO

com.choosemuse.libmuse.MuseDataPacketType.GYRO

3-axis gyro data packet A Gyro packet provides 3 pieces of data.

See also
  • Gyro for mapping details.

§ HSI

com.choosemuse.libmuse.MuseDataPacketType.HSI

EEG derived value. HSI values represent the fit of the headband. (known as headband status indicator). This value is not emitted by the LibMuse SDK.

§ HSI_PRECISION

com.choosemuse.libmuse.MuseDataPacketType.HSI_PRECISION

EEG derived value. HSI precision values represent the fit of the headband. This packet contains 4 values corresponding to Eeg.EEG1 , Eeg.EEG2 , Eeg.EEG3 and Eeg.EEG4 . There are no MuseDataPacketType.HSI_PRECISION values for the auxillary channels.

Each channel represents the fit at that location. A value of 1 represents a good fit, 2 represents a mediocre fit, and a value or 4 represents a poor fit.

See also
  • Eeg for mapping details.

§ IS_GOOD

com.choosemuse.libmuse.MuseDataPacketType.IS_GOOD

EEG derived value. Is Good indicates whether or not the last 1 second of raw EEG data on each channel was good or not. Eye blinks or muscle movement can interfere with EEG data and cause Is Good to report that the data is not good. This is emitted every 1/10 of a second to represent the rolling window of the last second of EEG data. This is only useful for real time EEG analysis. This packet only contains 4 values for the 4 sensors on the headband, there is no support for the auxillary channels.

See also
  • Eeg for mapping details.

§ QUANTIZATION

com.choosemuse.libmuse.MuseDataPacketType.QUANTIZATION

Packet contains information about signal quantization. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

Each index in this packet corresponds to the same index in an EEG packet. Quantization occurs when there is a particularly noisy signal, which generally happens when there is not a good contact between the headband and the skin.

Higher numbers are worse; 1 is no quantization, and 16 is maximum quantization.

These values are used under the hood by the library and by Muse Elements in reconstructing the EEG signal and contributing to an overall measure of noise; it is extremely unlikely that you will be interested in them. For measuring noise, it is recommended to instead use the more useful computed values like 'headband_on' or 'hsi'.

Each quantization packet applies to the next 16 EEG packets.

See also
  • Eeg for mapping details.

§ THETA_ABSOLUTE

com.choosemuse.libmuse.MuseDataPacketType.THETA_ABSOLUTE

EEG derived value. Absolute theta band powers for each channel. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ THETA_RELATIVE

com.choosemuse.libmuse.MuseDataPacketType.THETA_RELATIVE

EEG derived value. Relative band powers for each channel. Values in this packet are in range [0; 1]. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ THETA_SCORE

com.choosemuse.libmuse.MuseDataPacketType.THETA_SCORE

EEG derived value. Theta band power scores for each channel. This packet contains the same amount of data as an EEG packet and has the same channel mapping.

See also

§ TOTAL

com.choosemuse.libmuse.MuseDataPacketType.TOTAL

The total number of possible data packet types

The documentation for this enum was generated from the following file: