You are here: Start » Function Reference » Camera Support » XSightSmartCamera » XSightSmartCamera_GrabImage

XSightSmartCamera_GrabImage

Header:	ThirdPartySdk.h
Namespace:	avl
Module:	ThirdParty

Captures an image using X-Sight smart camera.

Syntax

bool avl::XSightSmartCamera_GrabImage
(
	XSightSmartCamera_State& ioState,
	atl::Optional<int> inDeviceIndex,
	int inInputQueueSize,
	atl::Optional<const avl::XSightSmartCameraImageFormat&> inImageFormat,
	atl::Optional<int> inExposureTime,
	atl::Optional<int> inFrameRate,
	atl::Optional<bool> inGainAuto,
	atl::Optional<const atl::Array<int>&> inGain,
	atl::Optional<int> inBlackLevel,
	atl::Optional<bool> inWhiteBalanceAuto,
	atl::Optional<int> inContrast,
	atl::Optional<int> inGamma,
	atl::Optional<int> inLumination,
	atl::Optional<int> inSaturation,
	atl::Optional<int> inHUE,
	atl::Optional<int> inColorCorrection,
	atl::Optional<int> inSharpness,
	atl::Optional<bool> inTriggerMode,
	atl::Optional<const avl::XSightSmartCameraTriggerConfiguration&> inTriggerConfiguration,
	avl::Image& outImage
)

Parameters

Name	Type	Range	Default	Description
ioState	XSightSmartCamera_State&			Object used to maintain state of the function.
inDeviceIndex	Optional<int>		NIL	Device identifying number
inInputQueueSize	int	1 -	5	Capacity of output frames queue
inImageFormat	Optional<const XSightSmartCameraImageFormat&>		NIL
inExposureTime	Optional<int>	1 -	NIL	Exposure time in milliseconds
inFrameRate	Optional<int>	1 -	NIL
inGainAuto	Optional<bool>		NIL
inGain	Optional<const Array<int>&>		NIL
inBlackLevel	Optional<int>	1 -	NIL
inWhiteBalanceAuto	Optional<bool>		NIL
inContrast	Optional<int>	1 - 128	NIL
inGamma	Optional<int>	0 -	NIL
inLumination	Optional<int>	1 - 128	NIL
inSaturation	Optional<int>	1 -	NIL
inHUE	Optional<int>	1 -	NIL
inColorCorrection	Optional<int>	1 -	NIL
inSharpness	Optional<int>	1 -	NIL
inTriggerMode	Optional<bool>		NIL
inTriggerConfiguration	Optional<const XSightSmartCameraTriggerConfiguration&>		NIL
outImage	Image&			Captured image

Remarks

Camera driver software

inDeviceIndex can be used to pick one of multiple devices connected to the computer. inDeviceIndex can be set to:

Device Index - X-Sight smart camera identifying internal index.

Camera device driver software

This filter is intended to cooperate with a device using its vendor SDK. To be able to connect to a device, it is required to install X-Sight smart camera SDK.

Add DLL path to system environment variable is required.

Recommended Runtime version for Adaptive Vision Studio usage is 1.0.