XiApi_GrabImage


Captures an image from a XIMEA camera.

Syntax

C++
Python
 
def XiApi_GrabImage(
	state: XIAPIState,
	outImage: Image,
	/,
	*,
	inDeviceID: str | None = None,
	inImageDataFormat: XiApiImageDataFormat = XiApiImageDataFormat.MONO8,
	inTriggerSource: XiApiTriggerSource | None = None,
	inDownsampling: XiApiDownsampling | None = None,
	inExposureTime: int | None = None,
	inGain: float | None = None,
	inAoi: Box | None = None,
	inBadPixelCorrection: bool | None = None,
	inAutomaticExposureGain: bool | None = None
)
-> (
	outResult: bool,
	outFrameID: int,
	outTimestamp: int
)

Parameters

Name Type Range Default Description
Input will be modified ioState XIAPIState
Input value inDeviceID str | None None Camera chip ID or camera index
Input value inImageDataFormat XiApiImageDataFormat XiApiImageDataFormat.MONO8 Output data format
Input value inTriggerSource XiApiTriggerSource | None None Defines source of trigger
Input value inDownsampling XiApiDownsampling | None None Changes image resolution by binning or skipping
Input value inExposureTime int | None 0 - + None Exposure time in microseconds
Input value inGain float | None None Gain in dB
Input value inAoi Box | None None Required fragment of image to stream
Input value inBadPixelCorrection bool | None None Correction of bad pixels
Input value inAutomaticExposureGain bool | None None Automatic exposure gain
Output value outImage Image Captured frame
Output value outFrameID int Captured frame ID
Output value outTimestamp int Captured frame timestamp

Multithreaded environment

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