Dependents

class sofia_redux.scan.integration.dependents.dependents.Dependents(integration, name)

Bases: ABC

Initialize a “dependents” object.

The Dependents class contains separate float arrays of dependent values for both integration frames and integration channels. Methods exist to add and subtract dependents from frames or channels.

Parameters:

integrationIntegration

The integration to which the dependents will belong.

namestr

The name of the dependents object.

Attributes Summary

referenced_attributes

Methods Summary

add_async(channels_or_frames, value)	Add values to channel or frame dependents based on input.
add_for_channels(value)	Add values to channel dependents.
add_for_frames(value)	Add values to frame dependents.
apply([channels, start, end])	Add dependents to integration frames and channels.
clear([channels, start, end])	Remove dependents from integration frames and channels.
copy()	Return a copy of the dependents.
get(channels_or_frames)	Return the frame or channel dependent values.

Attributes Documentation

referenced_attributes = ['integration']

Methods Documentation

add_async(channels_or_frames, value)

Add values to channel or frame dependents based on input.

Parameters:

channels_or_framesChannels or ChannelData or Frames.

valuefloat or numpy.ndarray (float).

If an array, must be the same size as channels_or_frames.

Returns:

None

add_for_channels(value)

Add values to channel dependents.

Parameters:

valuefloat or numpy.ndarray (float).

If an array, must be the same size as channels.

Returns:

None

add_for_frames(value)

Add values to frame dependents.

Parameters:

valuefloat or numpy.ndarray (float).

If an array, must be the same size as frames.

Returns:

None

apply(channels=None, start=None, end=None)

Add dependents to integration frames and channels.

Parameters:

channelsChannels or ChannelData, optional

If not supplied, use the integration channels.

startint, optional

The starting frame to remove dependents. The default is the first frame.

endint, optional

The ending frame (exclusive) to remove dependents. The default is the last channel.

Returns:

None

clear(channels=None, start=None, end=None)

Remove dependents from integration frames and channels.

Removed dependents will be set to zero internally.

Parameters:

channelsChannels or ChannelData, optional

If not supplied, use the integration channels.

startint, optional

The starting frame to remove dependents. The default is the first frame.

endint, optional

The ending frame (exclusive) to remove dependents. The default is the last channel.

Returns:

None

copy()

Return a copy of the dependents.

Returns:

Dependents

get(channels_or_frames)

Return the frame or channel dependent values.

Parameters:

channels_or_framesChannels or ChannelData or Frames

Returns:

dependentsnumpy.ndarray (float)