FieldResponse

class sofia_redux.scan.channels.mode.field_response.FieldResponse(channel_group=None, gain_provider=None, name=None, floating=False, field=None, derivative_order=0)

Bases: Response

Returns a field response mode.

The field response mode is designed to return a signal based of a data field in the integration frame data.

Parameters:

channel_groupChannelGroup, optional

The channel group owned by the mode.

gain_providerstr or GainProvider, optional

If a string is provided a FieldGainProvider will be set to operate on the given field of the channel group.

namestr, optional

The name of the mode. If not provided, will be determined from the channel group name (if available).

floatingbool, optional

True if the signal is “floating”.

fieldstr, optional

The data field of the frame data on which to base the signal.

derivative_orderint, optional

Return the derivative of the signal if greater than zero to the appropriate order.

Returns:

None

Methods Summary

get_signal(integration)

Get a signal from an integration.

Methods Documentation

get_signal(integration)

Get a signal from an integration.

The retrieved signal will be based on a frame data field from the integration, and may be differentiated if the derivative_order attribute is non-zero.

Parameters:

integrationIntegration

Returns:

Signal