STC_GrabImage_WithTimeout


Captures a frame using an Omron device.

Syntax

C++
Python
 
def STC_GrabImage_WithTimeout(
	state: Omron_State,
	inTimeout: int,
	/,
	*,
	inDeviceID: str | None = None,
	inInputQueueSize: int = 4,
	inPixelFormat: OmronPixelFormat | None = None,
	inRoi: Box | None = None,
	inAcquisitionMode: OmronAcquisitionMode | None = None,
	inAcquisitionFrameCount: int | None = None,
	inFrameRate: float | None = None,
	inExposureAuto: bool | None = None,
	inExposureTime: float | None = None,
	inGainAuto: bool | None = None,
	inGain: float | None = None,
	inGamma: float | None = None,
	inBlackLevel: float | None = None,
	inTriggerEnable: bool | None = None,
	inTriggerSource: OmronTriggerSource | None = None,
	inTriggerActivation: OmronTriggerActivation | None = None,
	inTriggerDelay: float | None = None
)
-> (
	outResult: bool,
	outImage: Image | None,
	outFrameID: int | None,
	outTimestamp: int | None
)

Parameters

Name Type Range Default Description
Input will be modified ioState Omron_State
Input value inDeviceID str | None None Device identifying number
Input value inTimeout int 1 - Maximum time to wait for frame in milliseconds
Input value inInputQueueSize int 1 - 200 4 Capacity of output frames queue
Input value inPixelFormat OmronPixelFormat | None None Format of the pixels provided by the device
Input value inRoi Box | None None Region of interest
Input value inAcquisitionMode OmronAcquisitionMode | None None Acquisition mode of the device
Input value inAcquisitionFrameCount int | None None Number of frames to acquire in MultiFrame Acquisition mode
Input value inFrameRate float | None None Acquisition rate in Hertz at which the frames are captured
Input value inExposureAuto bool | None None Enables or disables the automatic exposure time control
Input value inExposureTime float | None None Exposure time in microseconds
Input value inGainAuto bool | None None Enables or disables the automatic gain control
Input value inGain float | None None Gain as an absolute physical value
Input value inGamma float | None None Gamma correction of pixel intensity
Input value inBlackLevel float | None None Black level as an absolute physical value
Input value inTriggerEnable bool | None None Controls if the selected trigger is active
Input value inTriggerSource OmronTriggerSource | None None Source of the acquisition trigger
Input value inTriggerActivation OmronTriggerActivation | None None Activation mode of the trigger
Input value inTriggerDelay float | None None Delay in microseconds to apply after the trigger reception before activating it
Output value outImage Image | None Captured frame
Output value outFrameID int | None Captured frame ID
Output value outTimestamp int | None Captured frame timestamp