brainaccess.core.device_features#

Classes#

DeviceFeatures

Provides an interface to query the supported features of a device.

Module Contents#

class brainaccess.core.device_features.DeviceFeatures(device_info)[source]#

Provides an interface to query the supported features of a device.

This class allows you to check for the presence of sensors like gyroscopes and accelerometers, determine the electrode configuration, and get the total number of electrodes available on the device.

Parameters:: device_info (DeviceInfo) – An object containing the device’s information, used to identify the specific model and its capabilities.
Raises:: BrainAccessException – If the device is not recognized or its features cannot be retrieved.

electrode_count()[source]#

Gets the total number of EEG/EMG electrodes on the device.

Returns:: The number of electrodes available for data acquisition.
Return type:: int

has_accel()[source]#

Checks if the device is equipped with an accelerometer.

Returns:: True if the device has an accelerometer, False otherwise.
Return type:: bool

has_gyro()[source]#

Checks if the device is equipped with a gyroscope.

Returns:: True if the device has a gyroscope, False otherwise.
Return type:: bool

is_bipolar()[source]#

Checks if the device uses bipolar electrodes.

Bipolar electrodes have distinct positive (P) and negative (N) contacts, which is important for certain types of measurements.

Returns:: True if the electrodes are bipolar, False otherwise.
Return type:: bool

handle[source]#