Gocator_GrabProfile_WithTimeout


Captures profile from Gocator device.

Syntax

C++
Python
 
def Gocator_GrabProfile_WithTimeout(
	state: Gocator_State,
	inInputQueueSize: int,
	inTimeout: int,
	/,
	*,
	inAddress: str | None = None
)
-> (
	outResult: bool,
	outProfileData: list[Point2D] | None,
	outProfileIntensity: Profile | None,
	outXScale: float | None,
	outXOffset: float | None,
	outZScale: float | None,
	outZOffset: float | None,
	outFrameInfo: GocatorFrameInfo | None
)

Parameters

Name Type Range Default Description
Input will be modified ioState Gocator_State
Input value inAddress str | None None Gocator Device identifying IP address (e.g. "127.0.0.1") or serial number (e.g. "SN:17335")
Input value inInputQueueSize int 1 - 50000 Number of incoming frames that can be buffered before the application is able to process them
Input value inTimeout int 10 -
Output value outProfileData list[Point2D] | None
Output value outProfileIntensity Profile | None
Output value outXScale float | None X scale in mm
Output value outXOffset float | None X offset in mm
Output value outZScale float | None Z scale in mm
Output value outZOffset float | None Z offset in mm
Output value outFrameInfo GocatorFrameInfo | None