GainProvider

class sofia_redux.scan.channels.gain_provider.gain_provider.GainProvider

Bases: ABC

The gain provider is an abstract class template, used to extract and set gain values for channel data.

Methods Summary

get_gain(channel_data)	Retrieve gain values from channel data.
set_gain(channel_data, gain)	Set gain values in the gain provider.
validate(mode)	Validate a given mode.

Methods Documentation

abstract get_gain(channel_data)

Retrieve gain values from channel data.

Parameters:

channel_dataChannelData or ChannelGroup

The channel data instance.

Returns:

gainsnumpy.ndarray (float)

The gain values.

abstract set_gain(channel_data, gain)

Set gain values in the gain provider.

Parameters:

channel_dataChannelData or ChannelGroup

The channel data instance.

gainnumpy.ndarray (float)

The gain values to set.

Returns:

None

abstract validate(mode)

Validate a given mode.

Parameters:

modeMode

The mode instance.

Returns:

None