IDS_GrabImage_WithTimeout


Captures an image from an IDS camera.

Syntax

C++
Python
 
def IDS_GrabImage_WithTimeout(
	state: IDS_BaseState,
	/,
	*,
	inDeviceID: str | None = None,
	inPixelFormat: str = "\"Mono8\"",
	inInputQueueSize: int = 3,
	inAutoReconnect: bool = True,
	inTriggerMode: IDSTriggerMode | None = None,
	inTimeout: int = 100,
	inAoi: Box | None = None,
	inFrameRate: float | None = None,
	inExposureTime: float | None = None,
	inHorizontalBinning: IDSBinning | None = None,
	inVerticalBinning: IDSBinning | None = None,
	inMirror: IDSMirror | None = None,
	inAutoBlackLevel: bool | None = None,
	inBlackLevelOffset: int | None = None,
	inGamma: int | None = None,
	inGainBoost: bool | None = None,
	inGainMaster: int | None = None,
	inGainRed: int | None = None,
	inGainGreen: int | None = None,
	inGainBlue: int | None = None
)
-> (
	outResult: bool,
	outImage: Image | None,
	outFrameNumber: int | None,
	outTimestamp: int | None
)

Parameters

Name Type Range Default Description
Input will be modified ioState IDS_BaseState
Input value inDeviceID str | None None Device serial number or user definable camera ID
Input value inPixelFormat str "\"Mono8\"" Pixel format. Supported values: Raw8, Mono8, Rgb8, Bgr8, Rgba8, Bgra8
Input value inInputQueueSize int 1 - 3 Capacity of input frames queue
Input value inAutoReconnect bool True Automatically reconnect with the camera
Input value inTriggerMode IDSTriggerMode | None None Camera trigger mode
Input value inTimeout int 10 - 100 Maximum time to wait for frame in milliseconds
Input value inAoi Box | None None Required fragment of image to stream
Input value inFrameRate float | None 0.1 - 400.0 None Frame rate
Input value inExposureTime float | None 0.0 - None Exposure time in microseconds
Input value inHorizontalBinning IDSBinning | None None Horizontal binning
Input value inVerticalBinning IDSBinning | None None Vertical binning
Input value inMirror IDSMirror | None None Mirror effect
Input value inAutoBlackLevel bool | None None Enable auto black level
Input value inBlackLevelOffset int | None 0 - None Black level offset
Input value inGamma int | None 1 - 1000 None Set gamma value
Input value inGainBoost bool | None None Set gain boost mode
Input value inGainMaster int | None 0 - 100 None Set gain master value
Input value inGainRed int | None 0 - 100 None Set gain red value
Input value inGainGreen int | None 0 - 100 None Set gain green value
Input value inGainBlue int | None 0 - 100 None Set gain blue value
Output value outImage Image | None Output image
Output value outFrameNumber int | None Output frame number
Output value outTimestamp int | None Output image timestamp

Multithreaded environment

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