Back to Aurora Vision Library Lite website

You are here: Start » Camera Support » Ensenso » Ensenso_GrabImage_WithTimeout

Ensenso_GrabImage_WithTimeout


Header: ThirdPartySdk.h
Namespace: avl

Captures Images using Ensenso.

Syntax

bool avl::Ensenso_GrabImage_WithTimeout
(
	Ensenso_State& ioState,
	const atl::Array<avl::EnsensoCameraInformation>& inDevices,
	const atl::Optional<atl::File>& inParametersFile,
	int inTimeout,
	atl::Conditional<avl::Image>& outImage1,
	atl::Conditional<avl::Image>& outImage2
)

Parameters

Name Type Range Default Description
Input will be modified ioState Ensenso_State& Object used to maintain state of the function.
Input value inDevices const Array<EnsensoCameraInformation>& Structures identifying devices.
Input value inParametersFile const Optional<File>& NIL Initial global parameters.
Input value inTimeout int 100 - 3600000 5000 Maximum time to wait for frame in milliseconds.
Output value outImage1 Conditional<Image>& Image from the left camera of a dual camera sensor or the only image from a single camera sensor.
Output value outImage2 Conditional<Image>& Image from the right camera of a dual camera sensor if exists.

Remarks

Initial parameters

Initial parameters are only set during capture start. To change parameters either restart the stream, or use appropriate Set/Get filters.

Settings

To obtain settings from the camera:

  • From NxView Parameters window
    • Launch NxView
    • Open camera
    • Open Parameters window (menu Capture->Parameters...)
    • Adjust settings as wanted
    • Use Save... button
  • From NxTreeEdit application
    • Either:
      • Launch Aurora Vision Studio, add Ensenso_GrabPoint3DGrid filter, Run it
      • Launch NxView, open camera
    • Launch NxTreeEdit, connect to wanted instance
    • Adjust settings as wanted, either in NxView or NxTreeEdit
    • right click on /Cameras/BySerialNo/WantedSerialNumber and select Copy value as JSON string
    • save to a simple text file using an editor

The settings include all camera parameters, including Link, Calibration and Parameters The saved file can be then used in inCalibrationFile and inSettingsFile arguments.

To obtain global parameters, follow previous NxTreeEdit step, but save the global /Parameters node.

Camera identification

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

inDevices can be used to pick one or many of multiple cameras connected to the computer.

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 Ensenso SDK software, and uEye driver (same as in IDS camera filters)

Ensenso SDK and uEye driver can be downloaded from the following website: https://www.optonic.com/en/support/download/ensenso-sdk/

Recommended Ensenso SDK version for Aurora Vision Studio usage is 3.5.1419 and uEye driver 4.96.1.

Multithreaded environment

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

See Also