Back to FabImage Library website

You are here: Start » Function Reference » Camera Support » AvSMART » AvSMART_GrabImage_WithTimeout

AvSMART_GrabImage_WithTimeout


Header: ThirdPartySdk.h
Namespace: fil
Module: ThirdParty

Captures images from a AvSMART device.

Applications: Use this filter if the trigger may be not coming for some time, while the application should perform other operations in the main loop continuously, or when the timeout situation must be explicitly detected, or when you want to process images from multiple cameras in a single loop and the cameras are sending images asynchronously.

Syntax

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

Parameters

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