Back to Adaptive Vision Library website

You are here: Start » Function Reference » Gocator » Gocator_GrabUniformProfile

Gocator_GrabUniformProfile


Header:ThirdPartySdk.h
Namespace:avl

Captures uniform profile from Gocator device.

Syntax

bool avl::Gocator_GrabUniformProfile
(
	Gocator_State& ioState,
	const atl::Optional<avl::GocatorAddress>& inAddress,
	int inInputQueueSize,
	avl::Profile& outProfileData,
	atl::Conditional<avl::Profile>& outProfileIntensity,
	atl::real& outZScale,
	atl::real& outZOffset,
	avl::GocatorFrameInfo& outFrameInfo
)

Parameters

Name Type Range Default Description
ioState Gocator_State& Object used to maintain state of the function.
inAddress const Optional<GocatorAddress>& NIL Gocator Device identifying IP address (e.g. "127.0.0.1") or serial number (e.g. "SN:17335")
inInputQueueSize int 1 - 200 Number of incoming frames that can be buffered before the application is able to process them
outProfileData Profile&
outProfileIntensity Conditional<Profile>&
outZScale real& Z scale in mm
outZOffset real& Z offset in mm
outFrameInfo GocatorFrameInfo&

Remarks

Device identification

When there is only one device connected, the field inAddress can be set to Auto. In this situation, the first available device will be used.

inAddress can be used to pick one of multiple devices connected to the computer. inAddress can be set to:

  • IP Address - Gocator Device identifying IP address (e.g. "127.0.0.1")
  • Serial Number - Gocator Device serial number with "SN:" prefix (e.g. "SN:17335")
Gocator emulator

This filter was tested with Gocator emulator in version 5.2.19.71.

Multithreaded environment

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

See Also