Back to FabImage Library website

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

XSightSmartCamera_GrabImage_WithTimeout


Header: ThirdPartySdk.h
Namespace: fil
Module: ThirdParty

Captures with timeout an image using X-Sight smart camera.

Syntax

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

Parameters

Name Type Range Default Description
Input will be modified ioState XSightSmartCamera_State& Object used to maintain state of the function.
Input value inDeviceIndex Optional<int> NIL Device identifying number
Input value inInputQueueSize int 1 - 5 Capacity of output frames queue
Input value inTimeout const Optional<int> 1 - 100 Frame timeout in milliseconds
Input value inImageFormat Optional<const XSightSmartCameraImageFormat&> NIL
Input value inExposureTime Optional<int> 1 - NIL Exposure time in milliseconds
Input value inFrameRate Optional<int> 1 - NIL
Input value inGainAuto Optional<bool> NIL
Input value inGain Optional<const Array<int>&> NIL
Input value inBlackLevel Optional<int> 1 - NIL
Input value inWhiteBalanceAuto Optional<bool> NIL
Input value inContrast Optional<int> 1 - 128 NIL
Input value inGamma Optional<int> 0 - NIL
Input value inLumination Optional<int> 1 - 128 NIL
Input value inSaturation Optional<int> 1 - NIL
Input value inHUE Optional<int> 1 - NIL
Input value inColorCorrection Optional<int> 1 - NIL
Input value inSharpness Optional<int> 1 - NIL
Input value inTriggerMode Optional<bool> NIL
Input value inTriggerConfiguration Optional<const XSightSmartCameraTriggerConfiguration&> NIL
Output value outImage Conditional<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 FabImage Studio usage is 1.0.

All the other parameters exposed by camera filters are optional, setting them to 'Auto' leaves related parameter unchanged in camera (device default or user set configuration).

See Also