XSightSmartCamera_GrabImage


Captures an image using X-Sight smart camera.

Syntax

C++
Python
 
def XSightSmartCamera_GrabImage(
	state: XSightSmartCamera_State,
	outImage: Image,
	/,
	*,
	inDeviceIndex: int | None = None,
	inInputQueueSize: int = 5,
	inImageFormat: XSightSmartCameraImageFormat | None = None,
	inExposureTime: int | None = None,
	inFrameRate: int | None = None,
	inGainAuto: bool | None = None,
	inGain: list[int] | None = None,
	inBlackLevel: int | None = None,
	inWhiteBalanceAuto: bool | None = None,
	inContrast: int | None = None,
	inGamma: int | None = None,
	inLumination: int | None = None,
	inSaturation: int | None = None,
	inHUE: int | None = None,
	inColorCorrection: int | None = None,
	inSharpness: int | None = None,
	inTriggerMode: bool | None = None,
	inTriggerConfiguration: XSightSmartCameraTriggerConfiguration | None = None
)
-> outResult: bool

Parameters

Name Type Range Default Description
Input will be modified ioState XSightSmartCamera_State
Input value inDeviceIndex int | None None Device identifying number
Input value inInputQueueSize int 1 - 5 Capacity of output frames queue
Input value inImageFormat XSightSmartCameraImageFormat | None None
Input value inExposureTime int | None 1 - None Exposure time in milliseconds
Input value inFrameRate int | None 1 - None
Input value inGainAuto bool | None None
Input value inGain list[int] | None None
Input value inBlackLevel int | None 1 - None
Input value inWhiteBalanceAuto bool | None None
Input value inContrast int | None 1 - 128 None
Input value inGamma int | None 0 - None
Input value inLumination int | None 1 - 128 None
Input value inSaturation int | None 1 - None
Input value inHUE int | None 1 - None
Input value inColorCorrection int | None 1 - None
Input value inSharpness int | None 1 - None
Input value inTriggerMode bool | None None
Input value inTriggerConfiguration XSightSmartCameraTriggerConfiguration | None None
Output value outImage Image Captured image