brainaccess.core.gain_mode#

Classes#

GainMode

Enumeration of the available gain modes for the device's amplifiers.

Functions#

`gain_mode_to_multiplier`(gain_mode)	Converts a GainMode enum member to its integer multiplier.
`multiplier_to_gain_mode`(multiplier)	Converts an integer multiplier to its corresponding GainMode enum member.

Module Contents#

class brainaccess.core.gain_mode.GainMode(*args, **kwds)[source]#

Bases: enum.Enum

Enumeration of the available gain modes for the device’s amplifiers.

The gain mode determines the amplification factor applied to the analog signal before it is digitized. Higher gain values are suitable for measuring low-amplitude signals, while lower gain values are better for signals with a larger dynamic range.

X1[source]#

1x gain.

Type:: int

X2[source]#

2x gain.

Type:: int

X4[source]#

4x gain.

Type:: int

X6[source]#

6x gain.

Type:: int

X8[source]#

8x gain.

Type:: int

X12[source]#

12x gain.

Type:: int

UNKNOWN[source]#

An unknown or unsupported gain mode.

Type:: int

UNKNOWN = 255[source]#

X1 = 0[source]#

X12 = 5[source]#

X2 = 1[source]#

X4 = 2[source]#

X6 = 3[source]#

X8 = 4[source]#

brainaccess.core.gain_mode.gain_mode_to_multiplier(gain_mode)[source]#

Converts a GainMode enum member to its integer multiplier.

Parameters:: gain_mode (GainMode) – The gain mode to convert.
Returns:: The integer multiplier corresponding to the gain mode (e.g., GainMode.X12 returns 12).
Return type:: int

brainaccess.core.gain_mode.multiplier_to_gain_mode(multiplier)[source]#

Converts an integer multiplier to its corresponding GainMode enum member.

Parameters:: multiplier (int) – The integer multiplier to convert.
Returns:: The GainMode enum member corresponding to the multiplier.
Return type:: GainMode