get_result

Client.get_result(frame_type: FrameType | str = 'singleframe_integrated', pixel_format: PixelFormat | DataType | str = 'UINT16', attributes='auto', histogram=None)

Get the specified type of frames in the desired pixel format and associated information.

Parameters:

• frame_type (FrameType | str) –

  The type of frame to get. Use the FrameType enum or a string. Most common:

  • virtual_image0 (or 1, 2, 3, 4)

  • external_image1 (or 2, 3, 4)

  • sumtotal

  • singleframe_integrated

• pixel_format (PixelFormat | str) –

  The pixel format to get. Use the PixelFormat enum or a string. One of the following:

  • DE8u

  • DE16u

  • DE32f

  • DE64f

• attributes (Attributes | str | None) – Defines the image to be returned, some members can be updated. Some members of this parameter are input only, some are input/output.

• histogram (Histogram | None) – Returns the histogram if desired. Some members of this parameter are input only, some are input/output.

Note

During acquisition, live frames will be returned; after acquisition, the last image will be returned.