Back to Aurora Vision Library website

You are here: Start » Function Reference » Camera Support » MATRIX VISION » mvGenTLAcquire_GrabImage_WithTimeout

mvGenTLAcquire_GrabImage_WithTimeout


Header: ThirdPartySdk.h
Namespace: avl
Module: ThirdParty

Captures a frame from MATRIX VISION cameras using mvGenTLAcquire SDK.

Syntax

bool avl::mvGenTLAcquire_GrabImage_WithTimeout
(
	mvGenTLAcquireState& ioState,
	atl::Optional<const atl::String&> inDeviceID,
	int inTimeout,
	atl::Optional<avl::MVGenTLPixelFormat::Type> inPixelFormat,
	atl::Optional<int> inExposureTime,
	atl::Optional<float> inGain,
	atl::Optional<float> inFrameRate,
	atl::Optional<const avl::Box&> inAoi,
	avl::MvIMPACTTriggerActivation::Type inTriggerMode,
	avl::MvIMPACTTriggerSource::Type inTriggerSource,
	atl::Conditional<avl::Image>& outImage
)

Parameters

Name Type Range Default Description
Input will be modified ioState mvGenTLAcquireState& Object used to maintain state of the function.
Input value inDeviceID Optional<const String&> NIL Device name or serial number of device
Input value inTimeout int 10 - 100 Maximum time to wait for frame in milliseconds
Input value inPixelFormat Optional<MVGenTLPixelFormat::Type> NIL Pixel format of output image
Input value inExposureTime Optional<int> 1 - + NIL Exposure time value
Input value inGain Optional<float> NIL Gain value
Input value inFrameRate Optional<float> 1.0 - NIL Frame rate in FPS
Input value inAoi Optional<const Box&> NIL Required fragment of image to stream
Input value inTriggerMode MvIMPACTTriggerActivation::Type Trigger mode
Input value inTriggerSource MvIMPACTTriggerSource::Type Source of trigger
Output value outImage Conditional<Image>& Captured frame

Remarks

Camera driver software

This filter is intended to cooperate with a camera using its vendor SDK. To be able to connect to a camera, it is required to install mvGenTL Acquire SDK software with camera dedicated drivers.

mvGenTL Acquire SDK software can be downloaded from the following website: www.matrix-vision.com. For Aurora Vision Studio 32-bit, mvGenTL Acquire x86 version is needed. For Aurora Vision Studio 64-bit, mvGenTL Acquire x86_x64 version of SDK is required.

Recommended mvGenTL Acquire SDK version for usage with Aurora Vision Studio is 2.49.0.

Camera identification

When there is only one camera connected to the computer, field inDeviceID can be set to Auto. In such case, first available camera will be found and connected.

inDeviceID can be used to pick one of multiple cameras connected to the computer. inDeviceID can be set to:

  • serial number - it should be specified on the device casing(e.g. GX001559),
  • product name - it finds camera by name (might be the same for many cameras). The product name is a bit more specific than the family name, but less specific than the serial number(e.g. mvBlueCOUGAR-X100wG),
  • product number - it finds camera by family name(e.g. mvBlueCOUGAR).
Camera parameters

Most of the parameters exposed by camera filters are optional, setting them to Auto leaves related parameter for automatic configuration by the camera driver.

To change other and more advanced camera parameters, use the wxPropView available with mvGenTL Acquire SDK. Refer to SDK documentation for information about parameters and how to save them into memory channels.

Multithreaded environment

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

See Also