Back to Adaptive Vision Library Lite website

You are here: Start » Allied Vision Technologies » Vimba_GrabImage

Vimba_GrabImage


Captures an image from an Allied Vision camera.

Syntax

bool avl::Vimba_GrabImage
(
	Vimba_State& ioState,
	atl::Optional<const atl::String&> inDeviceID,
	const avl::VimbaImageFormatParams& inImageFormat,
	const avl::VimbaAcquisitionControlParams& inAcquisitionControl,
	avl::Image& outImage
)

Parameters

Name Type Default Description
ioState Vimba_State& Object used to maintain state of the function.
inDeviceID Optional<const String&> NIL Device identifying address
inImageFormat const VimbaImageFormatParams& Image format parameters
inAcquisitionControl const VimbaAcquisitionControlParams& Acquisition control parameters
outImage Image& Captured frame

Remarks

Camera driver software

This filter is intended to cooperate with cameras using their vendor's SDK. In order to connect with the camera, it is required to install Vimba SDK software.

Vimba SDK can be downloaded from the following website: https://www.alliedvision.com/en/products/software.html

To verify the driver installation, you can run Vimba Viewer. If the camera was detected and you can see the view from the camera, you can use Vimba SDK in Adaptive Vision Studio.

Recommended Vimba SDK version for Adaptive Vision Studio usage is 2.1.

Camera identification

When there is only one Allied Vision camera connected, the field inDeviceID can be set to Auto. In this situation, the first available camera will be used.

inDeviceID can be used to pick one of multiple cameras connected to the computer. inDeviceID should be set to camera ID.

Multithreaded environment

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