OptoEngineeringHRAS_COE71_GrabImage


Captures an image using COE-71 Opto Engineering device.

Syntax

C++
Python
 
def OptoEngineeringHRAS_COE71_GrabImage(
	state: OptoEngineering_State,
	inBitDepth: OptoEngineeringBitDepth,
	outImage: Image,
	/,
	*,
	inDeviceID: str | None = None,
	inInputQueueSize: int = 12,
	inStrobePolarity: OptoEngineering_COE71_StrobePolarity | None = None,
	inTriggerMode: OptoEngineering_COE71_TriggerMode = OptoEngineering_COE71_TriggerMode.FreeRun,
	inDigitalGain: float | None = None,
	inDigitalOffset: int | None = None,
	inExposureTime: int | None = None,
	inExposureUnit: OptoEngineeringExposureUnit = OptoEngineeringExposureUnit.Millisecond
)
-> outResult: bool

Parameters

Name Type Range Default Description
Input will be modified ioState OptoEngineering_State
Input value inDeviceID str | None None Device identifying number
Input value inInputQueueSize int 1 - 12 Capacity of output frames queue
Input value inBitDepth OptoEngineeringBitDepth Number of pixel bits
Input value inStrobePolarity OptoEngineering_COE71_StrobePolarity | None None Polarity of strobe output signal
Input value inTriggerMode OptoEngineering_COE71_TriggerMode OptoEngineering_COE71_TriggerMode.FreeRun Device triggering mode
Input value inDigitalGain float | None 0.0 - 16.0 None Gain of source image in device raw unit
Input value inDigitalOffset int | None -32767 - 32767 None Offset of source image in device raw unit
Input value inExposureTime int | None 1 - 65535 None Camera frame exposition time
Input value inExposureUnit OptoEngineeringExposureUnit OptoEngineeringExposureUnit.Millisecond Camera frame exposition time unit
Output value outImage Image Captured frame

Multithreaded environment

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