get_result

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

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:

  • UINT8

  • UINT16

  • FLOAT32

• 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.

• **kwargs (Additional keyword arguments used to create an Attributes Object.) –

  windowWidth: int

  The width of the window to return. If 0, the full width will be returned.

  windowHeight: int

  The height of the window to return. If 0, the full height will be returned.

  centerX: int

  The x center of the window to return.

  centerY: int

  The y center of the window to return.

  zoom: float

  The zoom factor to apply to the image.

  fft: bool

  If True, return the FFT of the image.

  stretchType: int

  The type of stretch to apply to the image. Only used if commandVersion >= 10.

  manualStretchMin: float

  The minimum value for manual stretch. Only used if commandVersion >= 10.

  manualStretchMax: float

  The maximum value for manual stretch. Only used if commandVersion >= 10.

  manualStretchGamma: float

  The gamma value for manual stretch. Only used if commandVersion >= 10.

  linearStretch: bool

  If True, apply a linear stretch to the image. Only used if commandVersion < 10.

  outlierPercentage: float

  The percentage of outliers to ignore when stretching the image.

Note

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