Back to Aurora Vision Library Lite website

You are here: Start » Camera Support » Smart » Smart_GrabImage_GenICam

Smart_GrabImage_GenICam


Header: ThirdPartySdk.h
Namespace: avl

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

Syntax

bool avl::Smart_GrabImage_GenICam
(
	Smart_State& ioState,
	const avl::SmartIPAddress& inIpAddress,
	atl::Optional<const avl::GenAddress&> inDeviceID,
	atl::Optional<avl::RemoteGrabberPixelFormat::Type> inPixelFormat,
	avl::Image& outImage,
	bool& outIsRemote
)

Parameters

Name Type 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 inDeviceID Optional<const GenAddress&> NIL Tries to find the camera in all available IDs (UserID, VendorName, ModelName...)
Input value inPixelFormat Optional<RemoteGrabberPixelFormat::Type> NIL
Output value outImage Image& Captured frame
Output value outIsRemote bool&

Hints

  • Check the IP address of your runtime system (e.g. using the "ipconfig" command) and set it to the inIpAddress input.
  • Set an appropriate inPixelFormat.
  • Run the program on you runtime system and the camera filter will acquire images directly on it.
  • Run the program on your development machine (e.g. your laptop) connected to the same Ethernet and the camera filter will receive images through a connection with the runtime system.

Troubleshooting:

  • Turn off the firewall on the device where the runtime system is launched.
  • Check the inDeviceID parameter and either select the GenTL device from the manager ([...] icon on the right) or manually set the parameters if the GenTL is not available (plus icon on the left). In this case you have to fill in all the positions on the list (inDeviceID.VendorName, inDeviceID.TLType, inDeviceID.DeviceID).

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_GenICam is not supported in the Lite edition.