brainaccess.core.stream_rate#

Classes#

StreamRate

Enumeration of the available sample rates for the device's amplifiers.

Module Contents#

class brainaccess.core.stream_rate.StreamRate(*args, **kwds)[source]#

Bases: enum.Enum

Enumeration of the available sample rates for the device’s amplifiers.

X16kHz[source]#

16000 samples per second.

Type:

int

X8kHz[source]#

8000 samples per second.

Type:

int

X4kHz[source]#

4000 samples per second.

Type:

int

X2kHz[source]#

2000 samples per second.

Type:

int

X1kHz[source]#

1000 samples per second.

Type:

int

X500Hz[source]#

500 samples per second.

Type:

int

X250Hz[source]#

250 samples per second.

Type:

int

UNKNOWN[source]#

An unknown or unsupported stream rate.

Type:

int

classmethod from_hz(hz)[source]#

Creates a StreamRate instance from a frequency in Hz.

Parameters:

hz (int) – The frequency in Hertz.

Returns:

The corresponding StreamRate member, or UNKNOWN if not found.

Return type:

StreamRate

UNKNOWN = 255[source]#
X16kHz = 0[source]#
X1kHz = 4[source]#
X250Hz = 6[source]#
X2kHz = 3[source]#
X4kHz = 2[source]#
X500Hz = 5[source]#
X8kHz = 1[source]#
property to_hz: int[source]#

Gets the sample rate frequency in Hz.

Returns:

The frequency in Hertz, or -1 if the rate is unknown.

Return type:

int