IFM_GrabImage_WithTimeout


Captures an image from an ifm device.

Syntax

C++
Python
 
def IFM_GrabImage_WithTimeout(
	state: Ifm_State,
	inAddress: IFMCameraAddress,
	/,
	*,
	inTimeout: int = 100,
	inGrab3dCoordinates: bool = False,
	inFrameRate: float | None = None,
	inResolution: IFMResolution | None = None,
	inTriggerMode: IFMTriggerMode | None = None
)
-> (
	outResult: bool,
	outDistancesImage: Image | None,
	outAmplitudeImage: Image | None,
	outInvalidRois: list[Region] | None,
	out3dCoordinates: Point3DGrid | None
)

Parameters

Name Type Range Default Description
Input will be modified ioState Ifm_State
Input value inAddress IFMCameraAddress Device identifying address
Input value inTimeout int 0 - 100 Maximum time to wait for frame in milliseconds
Input value inGrab3dCoordinates bool False Enable 3d coordinates capturing
Input value inFrameRate float | None 0.017 - 300.0 None Sets the target frame rate in fps at which device should capture images
Input value inResolution IFMResolution | None None Sets the resolution of output image
Input value inTriggerMode IFMTriggerMode | None None Sets the trigger mode on device for capturing image
Output value outDistancesImage Image | None Captured distance image
Output value outAmplitudeImage Image | None Captured amplitude image
Output value outInvalidRois list[Region] | None Region array with invalid pixels: INVALID, SATURATED, INCONSISTENT and LOW_SIGNAL.
Output value out3dCoordinates Point3DGrid | None Captured 3d coordinates

Multithreaded environment

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