Back to Adaptive Vision Library website

You are here: Start » Function Reference » Camera Support » Roseek » Roseek_GrabImage

Roseek_GrabImage


Header: ThirdPartySdk.h
Namespace: avl
Module: ThirdParty

Captures images from a Roseek device.

Syntax

bool avl::Roseek_GrabImage
(
	Roseek_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
Input will be modified
 ioState Roseek_State& Object used to maintain state of the function.
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 Image& Captured frame
Output value
 outFrameID int& Captured frame ID

Remarks

Camera driver software

This filter is intended to cooperate with camera using its vendor Roseek SDK. To be able to connect to camera it is required to install Roseek SDK software with camera dedicated drivers. Currently Adaptive Vision uses Roseek version v1.32.

Multithreaded environment

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