Microview_GrabImage


Captures a frame using Microview.

Syntax

C++
Python
 
def Microview_GrabImage(
	state: Microview_State,
	inInputQueueSize: int,
	outImage: Image,
	/,
	*,
	inDeviceID: int | None = None,
	inJumboFrameSupport: bool = True,
	inRescanNeeded: bool = False,
	inUsersSettingsParams: MicroviewUsersSettingsParams = MicroviewUsersSettingsParams(False, None, None, None),
	inImageFormat: MicroviewImageFormatParams = MicroviewImageFormatParams(False, False, True, None, None, None, None, None, None, None),
	inAcquisitionControl: MicroviewAcquisitionParams = MicroviewAcquisitionParams(None, None, None, None, None, False),
	inTriggerControl: MicroviewTriggerParams = MicroviewTriggerParams(False, None, None, None, None)
)
-> (
	outResult: bool,
	outFrameId: int
)

Parameters

Name Type Range Default Description
Input will be modified ioState Microview_State
Input value inDeviceID int | None 0 - 10000 None Device identifying number
Input value inInputQueueSize int 1 - 200 Capacity of output frames queue
Input value inJumboFrameSupport bool True
Input value inRescanNeeded bool False
Input value inUsersSettingsParams MicroviewUsersSettingsParams MicroviewUsersSettingsParams(False, None, None, None)
Input value inImageFormat MicroviewImageFormatParams MicroviewImageFormatParams(False, False, True, None, None, None, None, None, None, None)
Input value inAcquisitionControl MicroviewAcquisitionParams MicroviewAcquisitionParams(None, None, None, None, None, False)
Input value inTriggerControl MicroviewTriggerParams MicroviewTriggerParams(False, None, None, None, None)
Output value outImage Image Captured frame
Output value outFrameId int Frame id

Multithreaded environment

This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.