Back to Adaptive Vision Library website

You are here: Start » Function Reference » XIMEA » M3API_GrabImage_Deprecated

M3API_GrabImage_Deprecated


Captures an image from a XIMEA camera.

Syntax

bool avl::M3API_GrabImage_Deprecated
(
	M3API_GrabImage_DeprecatedState& ioState,
	atl::Optional<int> inDeviceID,
	atl::Optional<const avl::Box&> inAoi,
	atl::Optional<atl::real> inShutter,
	atl::Optional<atl::real> inGain,
	atl::Optional<int> inCameraModeNum,
	atl::Optional<avl::XIMEAFilterMode::Type> inFilterMode,
	atl::Optional<int> inAutoWBPeriod,
	atl::Optional<atl::real> inSharpness,
	atl::Optional<atl::real> inGammaY,
	atl::Optional<atl::real> inGammaC,
	atl::Optional<atl::real> inSaturation,
	atl::Optional<avl::XIMEATriggerMode::Type> inTriggerMode,
	atl::Optional<bool> inTriggerNegation,
	avl::Image& outImage
)

Parameters

Name Type Range Default Description
ioState M3API_GrabImage_DeprecatedState& Object used to maintain state of the function.
inDeviceID Optional<int> 0 - 10 NIL Camera chip ID or camera index
inAoi Optional<const Box&> NIL Dimensions of source image
inShutter Optional<real> 0.0 - 10000.0f Value of exposure set in microseconds
inGain Optional<real> -4.0 - 38.0 1.0f Gain value
inCameraModeNum Optional<int> 0 - 0 Mode number defining the resolution of camera [depends on cameras model]
inFilterMode Optional<XIMEAFilterMode::Type> NIL Filter mode defining the color of image
inAutoWBPeriod Optional<int> -1 - 0 Auto white balance period
inSharpness Optional<real> 0.0 - 4.0 0.0f Sharpening filter strength
inGammaY Optional<real> 0.01 - 1.0 1.0f Intensity gamma of source image
inGammaC Optional<real> 0.0 - 1.0 0.0f Saturation [color] gamma of source image
inSaturation Optional<real> 0.0 - 1.0 0.0f Saturation of source image
inTriggerMode Optional<XIMEATriggerMode::Type> NIL Determines, how the shutter is released
inTriggerNegation Optional<bool> NIL 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:

  1. Connect your camera to your computer.
  2. 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.

Multithreaded environment

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

See Also

M3API_GetDigitalInputs_Deprecated, M3API_SetDigitalOutputModes_Deprecated