Back to FabImage Library websiteYou are here:
Start »
Function Reference »
Camera Support »
Smart »
Smart_GrabImage_Roseek
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 |
|
ioState |
Smart_State& |
|
|
Object used to maintain state of the function. |
|
inIpAddress |
const SmartIPAddress& |
|
|
IP address of the runtime system (e.g. a smart camera) |
|
inPixelFormat |
RoseekImageFormat::Type |
|
|
Image color format |
|
inFrameRate |
Optional<float> |
|
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 |
|
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. |