Interface that is used to connect the LNX Mech-Eye device and access basic information of the device. More...

#include <MechEyeLNXApi.h>

Public Member Functions
	MechEyeDevice ()

	~MechEyeDevice ()

ErrorStatus	connect (const MechEyeDeviceInfo &info, const int timeout=10000)
	Connect to the device by the MechEyeDeviceInfo identifying a device.

ErrorStatus	connect (const std::string &ipAddress, const int port=5577, const int timeout=10000)
	Connects to a device by the IP address and port of the device.

void	disconnect ()
	Disconnect from the device.

ErrorStatus	getDeviceInfo (api::MechEyeDeviceInfo &info) const
	Get the basic information of the connected device.

ErrorStatus	saveAllSettingsToUserSets () const
	Save all parameter values to the current parameter group.

ErrorStatus	setCurrentUserSet (const std::string &userSetName) const

ErrorStatus	getCurrentUserSet (std::string &userSetName) const
	Get the name of the currently selected parameter group.

ErrorStatus	getAllUserSets (std::vector< std::string > &userSetNames) const
	Get the names of all available parameter groups.

ErrorStatus	deleteUserSet (const std::string &userSetName) const

ErrorStatus	addUserSet (const std::string &userSetName) const

ErrorStatus	captureLnx2DImage (ColorMap &colorMap) const
	Perform scanning of one line and obtain the line scan image.

ErrorStatus	getLnxBatchRollData (float depth, unsigned char intensity, unsigned int encoder, long long frameId, int &lineCount) const
	Get the acquired batch data.

ErrorStatus	getLnxBatchRollData (LineBatch &LineBatch) const
	Get the acquired batch data.

ErrorStatus	stopLnxCaptureImage ()
	Stop scanning.

ErrorStatus	startLnxCaptureImage ()
	Start scanning.

ErrorStatus	setLnxCaptureMode (CaptureMode value) const
	Set scan mode.

ErrorStatus	getLnxCaptureMode (CaptureMode &value) const
	Get the current scan mode.

ErrorStatus	setLnxRawTimeout (int time) const
	Set the timeout value for obtaining the line scan image.

ErrorStatus	getLnxRawTimeout (int &time) const
	Get the current timeout value for obtaining the line scan image.

ErrorStatus	setLnxDepthTimeout (int time) const
	Set the timeout value for obtaining the depth map.

ErrorStatus	getLnxDepthTimeout (int &time) const
	Get the current timeout value for obtaining the depth map.

ErrorStatus	getLnxXDataWidth (int &xDataWidth) const
	Get the line width in the X direction.

ErrorStatus	getLnxXScale (float &xScale) const
	Get the X resolution.

ErrorStatus	setLnxLaserPowerLevel (int powerLevel) const
	Set the laser power level.

ErrorStatus	getLnxLaserPowerLevel (int &powerLevel) const
	Get the current laser power level.

ErrorStatus	setScanExposureMode (ExposureMode mode) const
	Set the exposure mode.

ErrorStatus	getScanExposureMode (ExposureMode &mode) const
	Get the current exposure mode.

ErrorStatus	setLnxExposure (int time) const
	Set the exposure time for the Timed exposure mode.

ErrorStatus	getLnxExposure (int &time) const
	Get the current exposure time for the Timed exposure mode.

ErrorStatus	setScan3DHDRExposureSequence (int time1, int time2, int time3) const
	Set the exposure sequence for the HDR exposure mode.

ErrorStatus	getScan3DHDRExposureSequence (int &time1, int &time2, int &time3) const
	Get the current exposure sequence for the HDR exposure mode.

ErrorStatus	setLnxHDRDualSlope (int value) const
	Set the y-coordinate of the first HDR knee point.

ErrorStatus	getLnxHDRDualSlope (int &value) const
	Get the current y-coordinate of the first HDR knee point.

ErrorStatus	setLnxHDRTripleSlope (int value) const
	Set the y-coordinate of the second HDR knee point.

ErrorStatus	getLnxHDRTripleSlope (int &value) const
	Get the current y-coordinate of the second HDR knee point.

ErrorStatus	setScan3DAnalogGain (ImageAnalogGain gainVal) const
	Set the analog gain.

ErrorStatus	getScan3DAnalogGain (ImageAnalogGain &gainVal) const
	Get the current analog gain.

ErrorStatus	setScan3DAnalogGainFor8030 (ImageAnalogGainFor8030 gainVal) const
	Set the analog gain of LNX-8030.

ErrorStatus	getScan3DAnalogGainFor8030 (ImageAnalogGainFor8030 &gainVal) const
	Get the current analog gain of LNX-8030.

ErrorStatus	setScan3DDigitalGain (int gainVal) const
	Set the digital gain.

ErrorStatus	getScan3DDigitalGain (int &gainVal) const
	Get the current digital gain.

ErrorStatus	setLnxROIMode (ROIMode mode) const
	Set the ROI mode.

ErrorStatus	getLnxROIMode (ROIMode &mode) const
	Get the current ROI mode.

ErrorStatus	setLnxTriggerDelay (int delay) const
	Set the trigger delay time.

ErrorStatus	getLnxTriggerDelay (int &delay) const
	Get the current trigger delay time.

ErrorStatus	setLnxDepthTriggerSource (TriggerSource triggerSource) const
	Set the trigger source for the Depth scan mode. Note: this function can only be used in CaptureMode::Depth. It does not take effect in CaptureMode::Raw.

ErrorStatus	getLnxDepthTriggerSource (TriggerSource &triggerSource) const
	Get the current trigger source for the Depth scan mode.

ErrorStatus	setLnxLineRate (double rate) const
	Set the line rate for the Software trigger source.

ErrorStatus	getLnxLineRate (double &rate) const
	Get the current line rate for the Software trigger source.

ErrorStatus	setLnxProfileNum (int profileNum) const
	Set the maximum number of lines to be scanned.

ErrorStatus	getLnxProfileNum (int &profileNum) const
	Get the current maximum number of lines to be scanned.

ErrorStatus	setLnxEncoderTriggerMode (EncoderTriggerMode mode) const
	Set the encoder trigger mode.

ErrorStatus	getLnxEncoderTriggerMode (EncoderTriggerMode &mode) const
	Get the current encoder trigger mode.

ErrorStatus	setLnxEncoderDivide (int interval) const
	Set the encoder divider value. Camera frame rate = encoder signal rate * encoder multiplier / encoder divider.

ErrorStatus	getLnxEncoderDivide (int &interval) const
	Get the current encoder divider value.

ErrorStatus	setLnxEncoderMultiplier (EncoderMultiplier multiple) const
	Set the encoder multiplier value.

ErrorStatus	getLnxEncoderMultiplier (EncoderMultiplier &multiple) const
	Get the current encoder multiplier value.

ErrorStatus	setLnxFilterType (FilterType type) const
	Set the filter type.

ErrorStatus	getLnxFilterType (FilterType &type) const
	Get the filter type.

ErrorStatus	setLnxMeanFilterWindow (MeanFilterWindow window) const
	Set the window size for mean filtering.

ErrorStatus	getLnxMeanFilterWindow (MeanFilterWindow &window) const
	Get the current window size for mean filtering.

ErrorStatus	setLnxMedianFilterWindow (MedianFilterWindow window) const
	Set the window size for median filtering.

ErrorStatus	getLnxMedianFilterWindow (MedianFilterWindow &window) const
	Get the current window size for median filtering.

ErrorStatus	setLnxMaxFillingPointCount (int value) const
	Set the maximum number of invalid points to be interpolated.

ErrorStatus	getLnxMaxFillingPointCount (int &value) const
	Get the current maximum number of invalid points to be interpolated.

ErrorStatus	setLnxProfileStrategy (ProfileStrategy value) const
	Set profile extraction strategy.

ErrorStatus	getLnxProfileStrategy (ProfileStrategy &value) const
	Get the current profile extraction strategy.

ErrorStatus	setLnxGrayFilterThresh (int value) const
	Set the grayscale value threshold. Grayscale values of pixels below this threshold are set to zero before profile extraction.

ErrorStatus	getLnxGrayFilterThresh (int &value) const
	Get the current grayscale value threshold.

ErrorStatus	setLnxMinStripeWidth (int value)
	Set the minimum laser line width.

ErrorStatus	getLnxMinStripeWidth (int &value) const
	Get the current minimum laser line width.

ErrorStatus	setLnxMaxStripeWidth (int value)
	Set the maximum laser line width.

ErrorStatus	getLnxMaxStripeWidth (int &value) const
	Get the current maximum laser line width.

ErrorStatus	setLnxMinStripeIntensity (int value)
	Set the minimum laser line intensity.

ErrorStatus	getLnxMinStripeIntensity (int &value) const
	Get the current minimum laser line intensity.

ErrorStatus	setLnxMaxStripeIntensity (int value)
	Set the maximum laser line intensity.

ErrorStatus	getLnxMaxStripeIntensity (int &value) const
	Get the current maximum laser line intensity.

ErrorStatus	getLnxEncoderValue (unsigned int &value) const
	Get the current encoder value.

Static Public Member Functions
static std::vector< api::MechEyeDeviceInfo >	enumerateMechEyeDeviceList ()
	Enumerate Mech-Eye devices by the MechEyeDeviceInfo identifying the device.

Detailed Description

Interface that is used to connect the LNX Mech-Eye device and access basic information of the device.

Definition at line 59 of file MechEyeLNXApi.h.

Constructor & Destructor Documentation

◆ MechEyeDevice()

mmind::api::lnxapi::MechEyeDevice::MechEyeDevice ( )

Constructor.

◆ ~MechEyeDevice()

mmind::api::lnxapi::MechEyeDevice::~MechEyeDevice ( )

Destructor.

Member Function Documentation

◆ addUserSet()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::addUserSet ( const std::string & userSetName ) const

Add a new parameter group, set all the current parameter values to it, and select it as the current parameter group.

Parameters

[in] userSetName

Returns: See ErrorStatus for details.

See also: saveAllSettingsToUserSets

◆ captureLnx2DImage()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::captureLnx2DImage ( ColorMap & colorMap ) const

Perform scanning of one line and obtain the line scan image.

Parameters

[out] colorMap See Frame for details.

Returns: See ErrorStatus for details.

◆ connect() [1/2]

ErrorStatus mmind::api::lnxapi::MechEyeDevice::connect	(	const MechEyeDeviceInfo &	info,
		const int	timeout = `10000`
	)

Connect to the device by the MechEyeDeviceInfo identifying a device.

Parameters

[in]	info	the device information used to connect to the device which can be obtained by enumerateMechEyeDeviceList function.
[in]	timeout	the timeout value (ms).

Returns: See ErrorStatus for details.

◆ connect() [2/2]

ErrorStatus mmind::api::lnxapi::MechEyeDevice::connect	(	const std::string &	ipAddress,
		const int	port = `5577`,
		const int	timeout = `10000`
	)

Connects to a device by the IP address and port of the device.

Parameters

[in]	ipAddress	the IP address of the device to be connected.
[in]	port	the port of the device to be connected.
[in]	timeout	the timeout value (ms).

Returns: See ErrorStatus for details.

◆ deleteUserSet()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::deleteUserSet ( const std::string & userSetName ) const

Delete the specified parameter group. If the input name is the currently selected parameter group's, the parameter group of the previous index value in the list will be selected instead.

Parameters

[in] userSetName

Returns: See ErrorStatus for details.

See also: saveAllSettingsToUserSets

◆ enumerateMechEyeDeviceList()

static std::vector< api::MechEyeDeviceInfo > mmind::api::lnxapi::MechEyeDevice::enumerateMechEyeDeviceList ( )

static

Enumerate Mech-Eye devices by the MechEyeDeviceInfo identifying the device.

Returns: Information on all detectable Mech-Eye devices.

◆ getAllUserSets()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getAllUserSets ( std::vector< std::string > & userSetNames ) const

Get the names of all available parameter groups.

Parameters

[out] userSetNames

Returns: See ErrorStatus for details.

See also: getCurrentUserSet

◆ getCurrentUserSet()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getCurrentUserSet ( std::string & userSetName ) const

Get the name of the currently selected parameter group.

Parameters

[out] userSetName

Returns: See ErrorStatus for details.

See also: getAllUserSets

◆ getDeviceInfo()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getDeviceInfo ( api::MechEyeDeviceInfo & info ) const

Get the basic information of the connected device.

Parameters

[out] info See MechEyeDeviceInfo for details.

Returns: See ErrorStatus for details.

◆ getLnxBatchRollData() [1/2]

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxBatchRollData	(	float *	depth,
		unsigned char *	intensity,
		unsigned int *	encoder,
		long long *	frameId,
		int &	lineCount
	)		const

Get the acquired batch data.

Parameters

[out]	depth	the depth value or profile value (mm)
[out]	intensity	the intensity value
[out]	encoder	the encoder value
[out]	frameId	the frame ID
[out]	lineCount	the count of frame

Returns: See ErrorStatus for details.

◆ getLnxBatchRollData() [2/2]

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxBatchRollData ( LineBatch & LineBatch ) const

Get the acquired batch data.

Parameters

[out] LineBatch See Frame for details.

Returns: See ErrorStatus for details.

◆ getLnxCaptureMode()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxCaptureMode ( CaptureMode & value ) const

Get the current scan mode.

Parameters

[out] value See CaptureMode for details.

Returns: See ErrorStatus for details.

◆ getLnxDepthTimeout()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxDepthTimeout ( int & time ) const

Get the current timeout value for obtaining the depth map.

Parameters

[out] time (ms)

Returns: See ErrorStatus for details.

◆ getLnxDepthTriggerSource()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxDepthTriggerSource ( TriggerSource & triggerSource ) const

Get the current trigger source for the Depth scan mode.

Parameters

[out] triggerSource See TriggerSource for details.

Returns: See ErrorStatus for details.

◆ getLnxEncoderDivide()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxEncoderDivide ( int & interval ) const

Get the current encoder divider value.

Parameters

[out] interval

Returns: See ErrorStatus for details.

◆ getLnxEncoderMultiplier()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxEncoderMultiplier ( EncoderMultiplier & multiple ) const

Get the current encoder multiplier value.

Parameters

[out] multiple See EncoderMultiplier for details.

Returns: See ErrorStatus for details.

◆ getLnxEncoderTriggerMode()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxEncoderTriggerMode ( EncoderTriggerMode & mode ) const

Get the current encoder trigger mode.

Parameters

[out] mode See EncoderTriggerMode for details.

Returns: See ErrorStatus for details.

◆ getLnxEncoderValue()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxEncoderValue ( unsigned int & value ) const

Get the current encoder value.

Parameters

[out] value

Returns: See ErrorStatus for details.

◆ getLnxExposure()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxExposure ( int & time ) const

Get the current exposure time for the Timed exposure mode.

Parameters

[in] time (μs)

Returns: See ErrorStatus for details.

◆ getLnxFilterType()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxFilterType ( FilterType & type ) const

Get the filter type.

Parameters

[out] type See FilterType for details.

Returns: See ErrorStatus for details.

◆ getLnxGrayFilterThresh()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxGrayFilterThresh ( int & value ) const

Get the current grayscale value threshold.

Parameters

[out] value

Returns: See ErrorStatus for details.

◆ getLnxHDRDualSlope()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxHDRDualSlope ( int & value ) const

Get the current y-coordinate of the first HDR knee point.

Parameters

[out] value.

Returns: See ErrorStatus for details.

◆ getLnxHDRTripleSlope()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxHDRTripleSlope ( int & value ) const

Get the current y-coordinate of the second HDR knee point.

Parameters

[out] value.

Returns: See ErrorStatus for details.

◆ getLnxLaserPowerLevel()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxLaserPowerLevel ( int & powerLevel ) const

Get the current laser power level.

Parameters

[out] powerLevel

Returns: See ErrorStatus for details.

◆ getLnxLineRate()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxLineRate ( double & rate ) const

Get the current line rate for the Software trigger source.

Parameters

[out] rate

Returns: See ErrorStatus for details.

◆ getLnxMaxFillingPointCount()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxMaxFillingPointCount ( int & value ) const

Get the current maximum number of invalid points to be interpolated.

Parameters

[out] value

Returns: See ErrorStatus for details.

◆ getLnxMaxStripeIntensity()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxMaxStripeIntensity ( int & value ) const

Get the current maximum laser line intensity.

Parameters

[out] value

Returns: See ErrorStatus for details.

◆ getLnxMaxStripeWidth()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxMaxStripeWidth ( int & value ) const

Get the current maximum laser line width.

Parameters

[out] value

Returns: See ErrorStatus for details.

◆ getLnxMeanFilterWindow()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxMeanFilterWindow ( MeanFilterWindow & window ) const

Get the current window size for mean filtering.

Parameters

[out] window See MeanFilterWindow for details.

Returns: See ErrorStatus for details.

◆ getLnxMedianFilterWindow()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxMedianFilterWindow ( MedianFilterWindow & window ) const

Get the current window size for median filtering.

Parameters

[out] window See MedianFilterWindow for details.

Returns: See ErrorStatus for details.

◆ getLnxMinStripeIntensity()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxMinStripeIntensity ( int & value ) const

Get the current minimum laser line intensity.

Parameters

[out] value

Returns: See ErrorStatus for details.

◆ getLnxMinStripeWidth()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxMinStripeWidth ( int & value ) const

Get the current minimum laser line width.

Parameters

[out] value

Returns: See ErrorStatus for details.

◆ getLnxProfileNum()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxProfileNum ( int & profileNum ) const

Get the current maximum number of lines to be scanned.

Parameters

[out] profileNum

Returns: See ErrorStatus for details.

◆ getLnxProfileStrategy()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxProfileStrategy ( ProfileStrategy & value ) const

Get the current profile extraction strategy.

Parameters

[out] value See ProfileStrategy for details.

Returns: See ErrorStatus for details.

◆ getLnxRawTimeout()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxRawTimeout ( int & time ) const

Get the current timeout value for obtaining the line scan image.

Parameters

[out] time (ms)

Returns: See ErrorStatus for details.

◆ getLnxROIMode()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxROIMode ( ROIMode & mode ) const

Get the current ROI mode.

Parameters

[out] mode See ROIMode for details.

Returns: See ErrorStatus for details.

◆ getLnxTriggerDelay()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxTriggerDelay ( int & delay ) const

Get the current trigger delay time.

Parameters

[out] delay (1-2600us)

Returns: See ErrorStatus for details.

◆ getLnxXDataWidth()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxXDataWidth ( int & xDataWidth ) const

Get the line width in the X direction.

Parameters

[out] xDataWidth

Returns: See ErrorStatus for details.

◆ getLnxXScale()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getLnxXScale ( float & xScale ) const

Get the X resolution.

Parameters

[out] xScale(um)

Returns: See ErrorStatus for details.

◆ getScan3DAnalogGain()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getScan3DAnalogGain ( ImageAnalogGain & gainVal ) const

Get the current analog gain.

Parameters

[out] gainVal See ImageAnalogGain for details.

Returns: See ErrorStatus for details.

◆ getScan3DAnalogGainFor8030()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getScan3DAnalogGainFor8030 ( ImageAnalogGainFor8030 & gainVal ) const

Get the current analog gain of LNX-8030.

Parameters

[out] gainVal See ImageAnalogGainFor8030 for details.

Returns: See ErrorStatus for details.

◆ getScan3DDigitalGain()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getScan3DDigitalGain ( int & gainVal ) const

Get the current digital gain.

Parameters

[out] gainVal

Returns: See ErrorStatus for details.

◆ getScan3DHDRExposureSequence()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getScan3DHDRExposureSequence	(	int &	time1,
		int &	time2,
		int &	time3
	)		const

Get the current exposure sequence for the HDR exposure mode.

Parameters

[out]	time1	the exposure time1 (μs)
[out]	time2	the exposure time2 (μs)
[out]	time3	the exposure time3 (μs)

Returns: See ErrorStatus for details.

◆ getScanExposureMode()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::getScanExposureMode ( ExposureMode & mode ) const

Get the current exposure mode.

Parameters

[out] mode ExposureMode for details.

Returns: See ErrorStatus for details.

◆ saveAllSettingsToUserSets()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::saveAllSettingsToUserSets ( ) const

Save all parameter values to the current parameter group.

Returns: See ErrorStatus for details.

◆ setCurrentUserSet()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setCurrentUserSet ( const std::string & userSetName ) const

Select the parameter group to use by its name.

Parameters

[in] userSetName

Returns: See ErrorStatus for details.

See also: saveAllSettingsToUserSets

◆ setLnxCaptureMode()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxCaptureMode ( CaptureMode value ) const

Set scan mode.

Parameters

[in] value See CaptureMode for details.

Returns: See ErrorStatus for details.

◆ setLnxDepthTimeout()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxDepthTimeout ( int time ) const

Set the timeout value for obtaining the depth map.

Parameters

[in] time (ms)

Returns: See ErrorStatus for details.

◆ setLnxDepthTriggerSource()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxDepthTriggerSource ( TriggerSource triggerSource ) const

Set the trigger source for the Depth scan mode.
Note: this function can only be used in CaptureMode::Depth. It does not take effect in CaptureMode::Raw.

Parameters

[in] triggerSource See TriggerSource for details.

Returns: See ErrorStatus for details.

◆ setLnxEncoderDivide()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxEncoderDivide ( int interval ) const

Set the encoder divider value. Camera frame rate = encoder signal rate * encoder multiplier / encoder divider.

Parameters

[in] interval

Returns: See ErrorStatus for details.

◆ setLnxEncoderMultiplier()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxEncoderMultiplier ( EncoderMultiplier multiple ) const

Set the encoder multiplier value.

Parameters

[in] multiple See EncoderMultiplier for details.

Returns: See ErrorStatus for details.

◆ setLnxEncoderTriggerMode()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxEncoderTriggerMode ( EncoderTriggerMode mode ) const

Set the encoder trigger mode.

Parameters

[in] mode See EncoderTriggerMode for details.

Returns: See ErrorStatus for details.

◆ setLnxExposure()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxExposure ( int time ) const

Set the exposure time for the Timed exposure mode.

Parameters

[in] time (μs)

Returns: See ErrorStatus for details.

◆ setLnxFilterType()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxFilterType ( FilterType type ) const

Set the filter type.

Parameters

[in] type See FilterType for details.

Returns: See ErrorStatus for details.

◆ setLnxGrayFilterThresh()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxGrayFilterThresh ( int value ) const

Set the grayscale value threshold. Grayscale values of pixels below this threshold are set to zero before profile extraction.

Parameters

[in] value

Returns: See ErrorStatus for details.

◆ setLnxHDRDualSlope()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxHDRDualSlope ( int value ) const

Set the y-coordinate of the first HDR knee point.

Parameters

[in] value.

Returns: See ErrorStatus for details.

◆ setLnxHDRTripleSlope()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxHDRTripleSlope ( int value ) const

Set the y-coordinate of the second HDR knee point.

Parameters

[in] value.

Returns: See ErrorStatus for details.

◆ setLnxLaserPowerLevel()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxLaserPowerLevel ( int powerLevel ) const

Set the laser power level.

Parameters

[in] powerLevel

Returns: See ErrorStatus for details.

◆ setLnxLineRate()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxLineRate ( double rate ) const

Set the line rate for the Software trigger source.

Parameters

[in] rate

Returns: See ErrorStatus for details.

◆ setLnxMaxFillingPointCount()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxMaxFillingPointCount ( int value ) const

Set the maximum number of invalid points to be interpolated.

Parameters

[in] value

Returns: See ErrorStatus for details.

◆ setLnxMaxStripeIntensity()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxMaxStripeIntensity ( int value )

Set the maximum laser line intensity.

Parameters

[in] value

Returns: See ErrorStatus for details.

◆ setLnxMaxStripeWidth()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxMaxStripeWidth ( int value )

Set the maximum laser line width.

Parameters

[in] value

Returns: See ErrorStatus for details.

◆ setLnxMeanFilterWindow()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxMeanFilterWindow ( MeanFilterWindow window ) const

Set the window size for mean filtering.

Parameters

[in] window See MeanFilterWindow for details.

Returns: See ErrorStatus for details.

◆ setLnxMedianFilterWindow()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxMedianFilterWindow ( MedianFilterWindow window ) const

Set the window size for median filtering.

Parameters

[in] window See MedianFilterWindow for details.

Returns: See ErrorStatus for details.

◆ setLnxMinStripeIntensity()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxMinStripeIntensity ( int value )

Set the minimum laser line intensity.

Parameters

[in] value

Returns: See ErrorStatus for details.

◆ setLnxMinStripeWidth()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxMinStripeWidth ( int value )

Set the minimum laser line width.

Parameters

[in] value

Returns: See ErrorStatus for details.

◆ setLnxProfileNum()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxProfileNum ( int profileNum ) const

Set the maximum number of lines to be scanned.

Parameters

[in] profileNum

Returns: See ErrorStatus for details.

◆ setLnxProfileStrategy()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxProfileStrategy ( ProfileStrategy value ) const

Set profile extraction strategy.

Parameters

[in] value See ProfileStrategy for details.

Returns: See ErrorStatus for details.

◆ setLnxRawTimeout()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxRawTimeout ( int time ) const

Set the timeout value for obtaining the line scan image.

Parameters

[in] time (ms)

Returns: See ErrorStatus for details.

◆ setLnxROIMode()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxROIMode ( ROIMode mode ) const

Set the ROI mode.

Parameters

[in] mode See ROIMode for details.

Returns: See ErrorStatus for details.

◆ setLnxTriggerDelay()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setLnxTriggerDelay ( int delay ) const

Set the trigger delay time.

Parameters

[in] delay (1-2600us)

Returns: See ErrorStatus for details.

◆ setScan3DAnalogGain()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setScan3DAnalogGain ( ImageAnalogGain gainVal ) const

Set the analog gain.

Parameters

[in] gainVal See ImageAnalogGain for details.

Returns: See ErrorStatus for details.

◆ setScan3DAnalogGainFor8030()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setScan3DAnalogGainFor8030 ( ImageAnalogGainFor8030 gainVal ) const

Set the analog gain of LNX-8030.

Parameters

[in] gainVal See ImageAnalogGainFor8030 for details.

Returns: See ErrorStatus for details.

◆ setScan3DDigitalGain()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setScan3DDigitalGain ( int gainVal ) const

Set the digital gain.

Parameters

[in] gainVal

Returns: See ErrorStatus for details.

◆ setScan3DHDRExposureSequence()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setScan3DHDRExposureSequence	(	int	time1,
		int	time2,
		int	time3
	)		const

Set the exposure sequence for the HDR exposure mode.

Parameters

[in]	time1	the exposure time1 (μs)
[in]	time2	the exposure time2 (μs)
[in]	time3	the exposure time3 (μs)

Returns: See ErrorStatus for details.

◆ setScanExposureMode()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::setScanExposureMode ( ExposureMode mode ) const

Set the exposure mode.

Parameters

[in] mode ExposureMode for details.

Returns: See ErrorStatus for details.

◆ startLnxCaptureImage()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::startLnxCaptureImage ( )

Start scanning.

Returns: See ErrorStatus for details.

◆ stopLnxCaptureImage()

ErrorStatus mmind::api::lnxapi::MechEyeDevice::stopLnxCaptureImage ( )

Stop scanning.

Returns: See ErrorStatus for details.

The documentation for this class was generated from the following file:

deprecated/MechEyeLNXApi.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MechEyeDevice()

◆ ~MechEyeDevice()

Member Function Documentation

◆ addUserSet()

◆ captureLnx2DImage()

◆ connect() [1/2]

◆ connect() [2/2]

◆ deleteUserSet()

◆ enumerateMechEyeDeviceList()

◆ getAllUserSets()

◆ getCurrentUserSet()

◆ getDeviceInfo()

◆ getLnxBatchRollData() [1/2]

◆ getLnxBatchRollData() [2/2]

◆ getLnxCaptureMode()

◆ getLnxDepthTimeout()

◆ getLnxDepthTriggerSource()

◆ getLnxEncoderDivide()

◆ getLnxEncoderMultiplier()

◆ getLnxEncoderTriggerMode()

◆ getLnxEncoderValue()

◆ getLnxExposure()

◆ getLnxFilterType()

◆ getLnxGrayFilterThresh()

◆ getLnxHDRDualSlope()

◆ getLnxHDRTripleSlope()

◆ getLnxLaserPowerLevel()

◆ getLnxLineRate()

◆ getLnxMaxFillingPointCount()

◆ getLnxMaxStripeIntensity()

◆ getLnxMaxStripeWidth()

◆ getLnxMeanFilterWindow()

◆ getLnxMedianFilterWindow()

◆ getLnxMinStripeIntensity()

◆ getLnxMinStripeWidth()

◆ getLnxProfileNum()

◆ getLnxProfileStrategy()

◆ getLnxRawTimeout()

◆ getLnxROIMode()

◆ getLnxTriggerDelay()

◆ getLnxXDataWidth()

◆ getLnxXScale()

◆ getScan3DAnalogGain()

◆ getScan3DAnalogGainFor8030()

◆ getScan3DDigitalGain()

◆ getScan3DHDRExposureSequence()

◆ getScanExposureMode()

◆ saveAllSettingsToUserSets()

◆ setCurrentUserSet()

◆ setLnxCaptureMode()

◆ setLnxDepthTimeout()

◆ setLnxDepthTriggerSource()

◆ setLnxEncoderDivide()

◆ setLnxEncoderMultiplier()

◆ setLnxEncoderTriggerMode()

◆ setLnxExposure()

◆ setLnxFilterType()

◆ setLnxGrayFilterThresh()

◆ setLnxHDRDualSlope()

◆ setLnxHDRTripleSlope()

◆ setLnxLaserPowerLevel()

◆ setLnxLineRate()

◆ setLnxMaxFillingPointCount()

◆ setLnxMaxStripeIntensity()

◆ setLnxMaxStripeWidth()

◆ setLnxMeanFilterWindow()

◆ setLnxMedianFilterWindow()

◆ setLnxMinStripeIntensity()

◆ setLnxMinStripeWidth()

◆ setLnxProfileNum()

◆ setLnxProfileStrategy()

◆ setLnxRawTimeout()

◆ setLnxROIMode()

◆ setLnxTriggerDelay()

◆ setScan3DAnalogGain()

◆ setScan3DAnalogGainFor8030()