Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » GenICam » GenICam_GrabImage


Captures an image stream from a camera using a GenICam GenTL provider library.

Name Type Range Description
inAddress GenAddress GenTL Provider module and device identifying address
inPixelFormat GenPixelFormat Requested Pixel Format in GenICam pixel naming convention
inInputQueueSize Integer 1 - 200 Number of incoming frames that can be buffered before the application is able to process them
outFrame Image Captured frame
outFrameID Long Frame block ID set by device (when supported)
outTimestamp Long Frame capture timestamp set by device (when supported)


The most recommended filter for working with GenTL-compatible devices.


This filter is intended for establishing connection with general camera device using dedicated driver software trough GenTL compliant interface, for streaming images out of it in continuous mode.

Device address (inAddress port) is a structure of information defining unique device and its GenTL provider module in the system. It is recommended to use the GenTL Device Manager (click the "..." button in Filter Properties) to select the appropriate device, connected to the local system, whose identification information will be used.

Device address consists of the following fields:

  • VendorName - Vendor name of the GenTL provider module, which will be used to communicate with the device.
  • TLType - Identification code of interface transport technology type (for example "GEV", "IIDC", "UVC", "USB3", "PCI", "Custom"). The exact code depends on the GenTL provider module.
  • DeviceID - Unique ID of the device in the selected interface technology of the used provider module. The format of this field must be always an exact ID string and depends on the used GenTL provider module.

This filter will interpret the value of inAddress port only during the first iteration of its parent Task, when the connection to the device is established. During the next iterations the filter will use previously established connection and subsequent changes in the device address will be ignored.

Pixel format is a textual name of image pixel (color) format. Name of format must correspond to one of format names supported by device or error at program run will be raised. Use GenTL Device Manager (click "..." button in filter properties) to select format name from list of formats supported by connected device.

Filter will internally stream images in selected device pixel format. This format will be than converted to most appropriate application image format, in such way that no data will be lost.

Waiting time for new, valid image frame is not limited. For explicitly limiting timeout value and handling timeout condition, use GenICam_GrabImage_WithTimeout filter.

outFrameID output returns a sequentially incremented number identifying current frame in video sequence. Support of this parameter is optional and for some devices this output can be not effective. The value of this output is supplied by the GenTL provider library. Its support, range and wrap around depends on GenTL provider library and transport technology of the device. Refer to device vendor documentation for more information about Buffer FrameID. This value can be used to control correctness of received image sequence and detection of lost frames. Please note that this method can be used only to detect frames that was lost on application side. Detection of frames lost in device and transport layer depends on GenTL provider library implementation and device transport technology.

outTimestamp output returns a timestamp of current frame. Support of this parameter is optional and for some devices this output can be not effective. Frequency of the timer used for this timestamp is device and GenTL provider library dependent. Refer to device documentation for details about timestamp timer.

For general information about working with Gen TL devices, please refer to the following article.


  • Interactively select a camera available in your network by defining the inAddress input.
  • Choose inPixelFormat from those supported by your camera.


This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
IoError Connection with the device lost.

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of GenICam_GrabImage filter group.

See Also

  • GenICam_GrabImage_WithTimeout – Captures an image stream from a camera using a GenICam GenTL provider library; returns Nil if no frame comes in the specified time.