dodal.devices.current_amplifiers.CurrentAmp#

class dodal.devices.current_amplifiers.CurrentAmp[source]#
Base class for current amplifier, it contains the minimal functionality

a current amplifier needs:

gain_conversion_table#

The conversion table between current

Type:

Enum

and gain setting.
Parameters:

  • gain_conversion_table (type[Enum])

  • name (str, default: '')

Methods

decrease_gain([value])

Decrease gain, decrement by 1 by default.

get_gain()

Get the current gain setting

get_lowerlimit()

Get the lower limit of the current amplifier

get_upperlimit()

Get the upper limit of the current amplifier

increase_gain([value])

Increase gain, increment by 1 by default.

Attributes

abstract increase_gain(value: int = 1) → None[source]#

Increase gain, increment by 1 by default.

Returns:

True if success.

Return type:

bool

Parameters:

value (int, default: 1)

abstract decrease_gain(value: int = 1) → None[source]#

Decrease gain, decrement by 1 by default.

Returns:

True if success.

Return type:

bool

Parameters:

value (int, default: 1)

abstract get_gain() → type[Enum][source]#

Get the current gain setting

Returns:

The member name of the current gain setting in gain_conversion_table.

Return type:

Enum

abstract get_upperlimit() → float[source]#

Get the upper limit of the current amplifier

Return type:

float

abstract get_lowerlimit() → float[source]#

Get the lower limit of the current amplifier

Return type:

float