You are here: Start » Filter Reference » XIMEA » M3API_GrabImage_Deprecated
M3API_GrabImage_Deprecated
Captures an image from a XIMEA camera.
| Name | Type | Range | Description | |
|---|---|---|---|---|
 |
inDeviceID | Integer* | 0 - 10 | Camera chip ID or camera index |
|
inAoi | Box* | Dimensions of source image | |
|
inShutter | Real* | 0.0 -  |
Value of exposure set in microseconds |
|
inGain | Real* | -4.0 - 38.0 | Gain value |
|
inCameraModeNum | Integer* | 0 - |
Mode number defining the resolution of camera [depends on cameras model] |
|
inFilterMode | XIMEAFilterMode* | Filter mode defining the color of image | |
|
inAutoWBPeriod | Integer* | -1 - |
Auto white balance period |
|
inSharpness | Real* | 0.0 - 4.0 | Sharpening filter strength |
|
inGammaY | Real* | 0.01 - 1.0 | Intensity gamma of source image |
|
inGammaC | Real* | 0.0 - 1.0 | Saturation [color] gamma of source image |
|
inSaturation | Real* | 0.0 - 1.0 | Saturation of source image |
|
inTriggerMode | XIMEATriggerMode* | Determines, how the shutter is released | |
|
inTriggerNegation | Bool* | Negates the camera trigger mode | |
 |
outImage | Image | Output image | |
Description
This API is obsolete, please use xiApi filters instead.
To be able to use a XIMEA camera, you need to install camera driver. You can find it at the following address (select binaries):
https://www.ximea.com/support/wiki/apis/XIMEA_API_Software_Package
To install XIMEA camera driver, follow the steps below:
- Connect your camera to your computer.
- Manually select the path to the unpacked camera driver and install it.
To verify the driver installation, you can run xiApiViewer.exe (in the directory, where camera driver was unpacked). If the camera was detected and you can see the image from it, you can use your XIMEA camera in Adaptive Vision Studio.
Please note that the values of individual components (X, Y, Width, Height) of inAoi are camera specific (it's common that the values X, Y and Height have to be divisible by 2 and that the value of Width has to be divisible by 2). Incorrect value of one of these components results in an error during program execution.
Complexity Level
This filter is available on Basic Complexity Level.
