Back to FabImage Library website

You are here: Start » Function Reference » Camera Support » GoPxL » GoPxL_GrabUniformProfile

GoPxL_GrabUniformProfile


Header: ThirdPartySdk.h
Namespace: fil
Module: ThirdParty

Captures uniform profile from GoPxL device.

Syntax

bool fil::GoPxL_GrabUniformProfile
(
	GoPxL_State& ioState,
	const ftl::Optional<fil::GoPxLAddress>& inAddress,
	int inInputQueueSize,
	ftl::Optional<int> inSourceID,
	fil::Profile& outProfileData,
	ftl::Conditional<fil::Profile>& outProfileIntensity,
	ftl::real& outZScale,
	ftl::real& outZOffset,
	fil::GoPxLFrameInfo& outFrameInfo
)

Parameters

Name Type Range Default Description
Input will be modified ioState GoPxL_State& Object used to maintain state of the function.
Input value inAddress const Optional<GoPxLAddress>& NIL GoPxL Device identifying IP address (e.g. "127.0.0.1" or "127.0.0.1:3600") 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 inSourceID Optional<int> 0 - NIL ID of the data source in Gocator Protocol
Output value outProfileData Profile& ProfileData
Output value outProfileIntensity Conditional<Profile>& ProfileIntensity
Output value outZScale real& Z scale in mm
Output value outZOffset real& Z offset in mm
Output value outFrameInfo GoPxLFrameInfo& Frame metadata

Remarks

Device driver software

This filter is intended to cooperate with a Gocator device running GoPxL firmware. It is not required to install any additional software to connect to the device.

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 - GoPxL Device identifying IP address (e.g. "127.0.0.1" or "127.0.0.1:3600")
  • Serial Number - GoPxL Device serial number with "SN:" prefix (e.g. "SN:17335")
Gocator Protocol data source ID

When the field inSourceID is set to Auto, all data sources of a specific type would be processed by this filter. To process only one, chosen data source, set the value of this field to an appropriate ID. Data source IDs can be found in the GoPxL web interface, under Control/Gocator tab.

See Also

  • GoPxL_GrabPoint3DGrid_WithTimeout – Captures Point3DGrid (not resampled surface) from GoPxL device with timeout; returns Nil if no data comes in the specified time.