de_twin.transport.shm.FrameConsumer

class de_twin.transport.shm.FrameConsumer(name='DE_ExternalFrames', max_frame_bytes=33554432, slot_count=8)

Bases: _Mapping

What DE-Server does, in Python: create the mapping, request an acquisition, read frames.

Parameters:

• name (str)

• max_frame_bytes (int)

• slot_count (int)

__init__(name='DE_ExternalFrames', max_frame_bytes=33554432, slot_count=8)

Parameters:

• name (str)

• max_frame_bytes (int)

• slot_count (int)

Methods

__init__([name, max_frame_bytes, slot_count])
begin(*, frame_shape[, bytes_per_pixel, ...])
close()
end()
payload(n)
read([timeout, out])	The next frame of the current request, as (pixels, slot header).
slot(n)

begin(*, frame_shape, bytes_per_pixel=2, sensor_shape=None, exposure_mode=ExposureMode.NORMAL, frame_time_s=0.01, total_frames=0, roi=None, binning=(1, 1), scan_size=(0, 0), frames_per_scan_point=1)

Parameters:

• frame_shape (tuple[int, int])

• bytes_per_pixel (int)

• sensor_shape (tuple[int, int] | None)

• exposure_mode (ExposureMode)

• frame_time_s (float)

• total_frames (int)

• roi (Roi | None)

• binning (tuple[int, int])

• scan_size (tuple[int, int])

• frames_per_scan_point (int)

Return type:

int

read(timeout=1.0, out=None)

The next frame of the current request, as (pixels, slot header). With out (of the frame’s size and dtype) the pixels are copied into it, as DE-Server copies into its own buffers, instead of into a new array.

Parameters:

• timeout (float)

• out (ndarray | None)

Return type:

tuple[ndarray, dict]

end()

Return type:

None