Back to FabImage Library website

You are here: Start » Function Reference » Camera Support » Smart » Smart_GrabImage_Roseek

Smart_GrabImage_Roseek


Header: ThirdPartySdk.h
Namespace: fil
Module: ThirdParty

Captures an image from a smart camera using Roseek interface. Allows for remote access to the runtime system.

Syntax

bool fil::Smart_GrabImage_Roseek
(
	Smart_State& ioState,
	const fil::SmartIPAddress& inIpAddress,
	fil::RoseekImageFormat::Type inPixelFormat,
	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,
	fil::Image& outImage,
	bool& outIsRemote
)

Parameters

Name Type Range Default Description
Input will be modified ioState Smart_State& Object used to maintain state of the function.
Input value inIpAddress const SmartIPAddress& IP address of the runtime system (e.g. a smart camera)
Input value inPixelFormat RoseekImageFormat::Type Image color format
Input value inFrameRate Optional<float> 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 outIsRemote bool&

Multithreaded environment

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

Errors

List of possible exceptions:

Error type Description
RuntimeError Smart_GrabImage_Roseek is not supported in the Lite edition.