You are here: Start » Function Reference » AvSMART » AvSMART_GrabImage

AvSMART_GrabImage

Header:	ThirdPartySdk.h
Namespace:	avl

Captures images from a AvSMART device.

Syntax

bool avl::AvSMART_GrabImage
(
	AvSmart_State& ioState,
	int inInputQueueSize,
	avl::RoseekImageFormat::Type inImageFormat,
	atl::Optional<avl::RoseekResolutionMode::Type> inResolutionMode,
	const atl::Optional<avl::Box>& inROI,
	atl::Optional<float> inFrameRate,
	atl::Optional<avl::RoseekWorkingMode::Type> inWorkingMode,
	atl::Optional<int> inSensitivityLevel,
	atl::Optional<avl::RoseekExposureMode::Type> inExposureMode,
	atl::Optional<int> inExposureTime,
	atl::Optional<float> inGain,
	avl::Image& outImage,
	int& outFrameID
)

Parameters

Name	Type	Range	Default	Description
ioState	AvSmart_State&			Object used to maintain state of the function.
inInputQueueSize	int	1 - 1000	3	Number of incoming frames that can be buffered before the application is able to process them
inImageFormat	RoseekImageFormat::Type			Image pixel format
inResolutionMode	Optional<RoseekResolutionMode::Type>		NIL	Set resolution of image
inROI	const Optional<Box>&		NIL	Set resolution region. Has effect only if resolution mode is ROI.
inFrameRate	Optional<float>	0.1 - 400.0	NIL	Requested camera frame rate in frames per second
inWorkingMode	Optional<RoseekWorkingMode::Type>		NIL	Working mode of image acquisition
inSensitivityLevel	Optional<int>	0 - 3	NIL	Sensitivity level of camera sensor
inExposureMode	Optional<RoseekExposureMode::Type>		NIL	Exposure mode, should be set to Manual if you want to adjust inExposureTime manually
inExposureTime	Optional<int>	0 -	NIL	Camera frame exposition time
inGain	Optional<float>	0.0 - 36.0	NIL	Camera exposure gain
outImage	Image&			Captured frame
outFrameID	int&			Captured frame ID

Multithreaded environment

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