SmartRay_GrabImage_WithTimeout


Captures with timeout a live image using SmartRay.

Syntax

C++
Python
 
def SmartRay_GrabImage_WithTimeout(
	state: SmartRay_State,
	inAddress: str,
	inPort: int,
	inConnectionTimeout: int,
	/,
	*,
	inInputQueueSize: int = 4,
	inTimeout: int | None = 100,
	inDataTrigger: SmartRayDataTrigger = SmartRayDataTrigger(SmartRayDataTriggerMode.FreeRun, None, None, None, None, None),
	inRegionOfInterest: SmartRayRegionOfInterest | None = None,
	inExposure: SmartRayExposure | None = None,
	inLaser: SmartRayLaser | None = None,
	inStartTrigger: SmartRayStartTrigger | None = None,
	inReflectionFilter: SmartRayReflectionFilter | None = None,
	inLaserLineThreshold: list[int] | None = None,
	inMinLaserLineThicknessLimit: int | None = None,
	inMaxLaserLineThicknessLimit: int | None = None,
	inSmartXtract: bool | None = None,
	inSmartXtractAlgorithm: SmartRaySmartXtractAlgorithm | None = None,
	inSmartXactMode: SmartRaySmartXactMode | None = None
)
-> (
	outResult: bool,
	outImage: Image | None
)

Parameters

Name Type Range Default Description
Input will be modified ioState SmartRay_State
Input value inAddress str Device identifying address
Input value inPort int Device identifying network port
Input value inConnectionTimeout int 1 - 1000 Timeout in seconds
Input value inInputQueueSize int 1 - 200 4 Capacity of output frames queue
Input value inTimeout int | None 100 Frame timeout in milliseconds
Input value inDataTrigger SmartRayDataTrigger SmartRayDataTrigger(SmartRayDataTriggerMode.FreeRun, None, None, None, None, None)
Input value inRegionOfInterest SmartRayRegionOfInterest | None None
Input value inExposure SmartRayExposure | None None
Input value inLaser SmartRayLaser | None None
Input value inStartTrigger SmartRayStartTrigger | None None
Input value inReflectionFilter SmartRayReflectionFilter | None None
Input value inLaserLineThreshold list[int] | None None
Input value inMinLaserLineThicknessLimit int | None None
Input value inMaxLaserLineThicknessLimit int | None None
Input value inSmartXtract bool | None None
Input value inSmartXtractAlgorithm SmartRaySmartXtractAlgorithm | None None
Input value inSmartXactMode SmartRaySmartXactMode | None None
Output value outImage Image | None Captured live image

Multithreaded environment

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