Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » XIMEA » XiApi_GrabImage


Captures an image from a XIMEA camera.

Name Type Range Description
inDeviceID String* Camera chip ID or camera index
inImageDataFormat XiApiImageDataFormat Output data format
inTriggerSource XiApiTriggerSource Defines source of trigger
inDownsampling XiApiDownsampling Changes image resolution by binning or skipping
inExposureTime Integer* 0 - + Exposure time in microseconds
inGain Real* Gain in dB
inAoi Box* Required fragment of image to stream
inBadPixelCorrection Bool* Correction of bad pixels
inAutomaticExposureGain Bool* Automatic exposure gain
outImage Image Captured frame
outFrameID Long Captured frame ID
outTimestamp Long Captured frame timestamp


To be able to use a XIMEA camera, you need to install camera driver. You can find it at the following address (select binaries):

Pleas make sure that xiApi SDK is properly installed on your computer. To verify the driver installation, you can run xiApiViewer.exe. If the camera was detected and you can see the image from it, you can use your XIMEA camera in Adaptive Vision Studio.

Setting parameters

All the auto parameters (those with checkboxes in the Property window) are initially set to the default values of the camera (they are not changed in Adaptive Vision Studio). You can modify them by checking a checkbox and entering your own value.

The inDeviceID parameter is set only once when the filter is executed for the first time (if it set to Auto, the first available camera in the system will be used). All the other parameters are set during the first filter execution or when the parameter is changed (they are not set in every iteration when the value is not changed).

In inAoi parameter, the values of X, Y and Height should be even and the value of Width should be divisible by 4.

To set more complex parameters, please use one of the following filters: XiApi_SetParamInt, XiApi_SetParamFloat. Please note, that if you set some parameter value in the XiApi_GrabImage filter you should not modify it by xiApi_SetParamXxx filter - it may cause problems.


Description of usage of this filter can be found in examples and tutorial: HMI Recorder.


The full description of camera parameters can be found at the XIMEA website .

Alternatively you can also use GenICam filters to work with XIMEA cameras. Please refer to the article Working with Gen TL devices.

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of XiApi_GrabImage filter group.

See Also