ICube_GrabImage


Captures an image from an ICube camera.

Syntax

C++
Python
 
def ICube_GrabImage(
	state: ICube_State,
	outImage: Image,
	/,
	*,
	inDeviceID: int | None = None,
	inInputQueueSize: int = 10,
	inGrabbingMode: ICubeGrabMode = ICubeGrabMode.RAW,
	inResolutionMode: ICubeResolutionMode | None = None,
	inSkippingMode: ICubeBinSkip | None = None,
	inBinningMode: ICubeBinSkip | None = None,
	inExposureTime: float | None = None,
	inRoi: Box | None = None
)
-> (
	outResult: bool,
	outFrameID: int
)

Parameters

Name Type Range Default Description
Input will be modified ioState ICube_State
Input value inDeviceID int | None 0 - None Index of a camera
Input value inInputQueueSize int 1 - 1000 10
Input value inGrabbingMode ICubeGrabMode ICubeGrabMode.RAW
Input value inResolutionMode ICubeResolutionMode | None None
Input value inSkippingMode ICubeBinSkip | None None
Input value inBinningMode ICubeBinSkip | None None
Input value inExposureTime float | None 0.0 - None
Input value inRoi Box | None None Range of pixels to be processed
Output value outImage Image Captured frame
Output value outFrameID int Captured frame ID

Multithreaded environment

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