mmind::api Namespace Reference

Namespaces
namespace	lnxapi

Data Structures
struct	CameraIntri
	This struct defines camera intrinsic parameters. More...
struct	DepthRange
	This struct defines the depth range. More...
struct	DeviceIntri
	This struct defines device intrinsic parameters, including texture camera and depth camera. More...
struct	DeviceResolution
	This struct defines camera map resolution. More...
struct	DeviceTemperature
	This struct describes the device temperature information. More...
struct	ElementColor
	Element in ColorMap. More...
struct	ElementDepth
	Element in DepthMap. More...
struct	ElementPointXYZ
	Element in PointXYZMap. More...
struct	ElementPointXYZBGR
	Element in PointXYZBGRMap. More...
struct	ErrorStatus
	This enumeration defines the types of errors. More...
class	Frame
	Definition of data structure in device capturing image. More...
struct	HandeyeCalibrationSettings
struct	LaserSettings
class	LineBatch
class	MechEyeDevice
	Interface that is used to connect the Mech-Eye Industrial 3D Camera and access basic information of the device. More...
struct	MechEyeDeviceInfo
	This struct defines device information. More...
struct	PointCloudProcessingSettings
struct	Pose
	This struct defines rigid body transformations, including rotation matrix and translation vector. More...
struct	ProjectorSettings
struct	ROI
	This struct defines camera region of interest. More...
struct	Scanning2DSettings
struct	Scanning3DSettings
struct	UhpSettings

Typedefs
typedef Frame< ElementColor >	ColorMap
typedef Frame< ElementDepth >	DepthMap
typedef Frame< ElementPointXYZ >	PointXYZMap
typedef Frame< ElementPointXYZBGR >	PointXYZBGRMap

Enumerations
enum class	ExposureMode { HDR , Timed }
	This enumeration defines the exposure mode. More...
enum class	CaptureMode { Raw , Depth }
	This enumeration defines the scan mode. More...
enum class	TriggerSource { Software , Encoder }
	This enumeration defines the trigger source. More...
enum class	ImageAnalogGain {   AnalogGain_1_0 , AnalogGain_1_3 , AnalogGain_1_9 , AnalogGain_2_8 ,   AnalogGain_5_5 }
	This enumeration defines the image analog gain. More...
enum class	ImageAnalogGainFor8030 { AnalogGain_1_0 , AnalogGain_1_3 , AnalogGain_2_0 , AnalogGain_3_0 }
enum class	ROIMode {   Mode_1_1 , Mode_1_2 , Mode_1_4 , Mode_1_8 ,   Mode_1_16 }
	This enumeration defines the ROI along the Z direction. More...
enum class	EncoderTriggerMode { Positive , Negative , Duplex }
	This enumeration defines the encoder trigger mode. More...
enum class	EncoderMultiplier { Multiple_1 , Multiple_2 , Multiple_4 }
	This enumeration defines the encoder multiplier. More...
enum class	FilterType { None , Smoothing , Smoothing_edge_preserving , Median }
	This enumeration defines the filter type. More...
enum class	MeanFilterWindow {   Window_Size_0 , Window_Size_2 , Window_Size_4 , Window_Size_8 ,   Window_Size_16 , Window_Size_32 , Window_Size_64 }
	This enumeration defines the window size for mean filtering. More...
enum class	MedianFilterWindow {   Window_Size_0 , Window_Size_3 , Window_Size_5 , Window_Size_7 ,   Window_Size_9 }
	This enumeration defines the window size for median filtering. More...
enum class	ProfileStrategy {   Standard , Near , Far , Continous ,   Invalid }
	This enumeration defines the profile extraction strategy. More...

Functions
std::string MMIND_API_EXPORT	getApiInformation ()
	Gets the API basic information including version and manufacturing company.

Typedef Documentation

ColorMap

typedef Frame<ElementColor> ColorMap

DepthMap

typedef Frame<ElementDepth> DepthMap

PointXYZBGRMap

typedef Frame<ElementPointXYZBGR> PointXYZBGRMap

PointXYZMap

typedef Frame<ElementPointXYZ> PointXYZMap

Enumeration Type Documentation

CaptureMode

enum class CaptureMode

strong

This enumeration defines the scan mode.

Enumerator
Raw	The Raw mode.
Depth	The Depth mode.

EncoderMultiplier

enum class EncoderMultiplier

strong

This enumeration defines the encoder multiplier.

Enumerator
Multiple_1	Camera is triggered at the rising edge of the leading channel.
Multiple_2	Camera is triggered by the rising edge of both channels.
Multiple_4	Camera is triggered by the rising edge and falling edge of both channels.

EncoderTriggerMode

enum class EncoderTriggerMode

strong

This enumeration defines the encoder trigger mode.

Enumerator
Positive	Camera is triggered when the encoder rotates in the positive direction. Pulse count increases.
Negative	Camera is triggered when the encoder rotates in the negative direction. Pulse count decreases.
Duplex	Camera is triggered in both directions. When the encoder rotates in the positive direction, pulse count increases; when the encoder rotates in the negative direction, pulse count decreases.

ExposureMode

enum class ExposureMode

strong

This enumeration defines the exposure mode.

Enumerator
HDR	Generate images of high dynamic ranges showing more details with multiple different exposures.
Timed	Fixed exposure time, recommended in stable ambient light conditions.

FilterType

enum class FilterType

strong

This enumeration defines the filter type.

Enumerator
None	No filtering algorithm applied.
Smoothing	Apply the algorithm of mean filtering without edge preserving.
Smoothing_edge_preserving	Apply the algorithm of mean filtering with edge preserving.
Median	Apply the algorithm of median filtering.

ImageAnalogGain

enum class ImageAnalogGain

strong

This enumeration defines the image analog gain.

Enumerator
AnalogGain_1_0	the analog gain value is 1.0
AnalogGain_1_3	the analog gain value is 1.3
AnalogGain_1_9	the analog gain value is 1.9
AnalogGain_2_8	the analog gain value is 2.8
AnalogGain_5_5	the analog gain value is 5.5

ImageAnalogGainFor8030

enum class ImageAnalogGainFor8030

strong

Enumerator
AnalogGain_1_0	the analog gain value is 1.0
AnalogGain_1_3	the analog gain value is 1.3
AnalogGain_2_0	the analog gain value is 2.0
AnalogGain_3_0	the analog gain value is 3.0

MeanFilterWindow

enum class MeanFilterWindow

strong

This enumeration defines the window size for mean filtering.

Enumerator
Window_Size_0	Do not apply mean filtering.
Window_Size_2	The window size for mean filtering is 2.
Window_Size_4	The window size for mean filtering is 4.
Window_Size_8	The window size for mean filtering is 8.
Window_Size_16	The window size for mean filtering is 16.
Window_Size_32	The window size for mean filtering is 32.
Window_Size_64	The window size for mean filtering is 64.

MedianFilterWindow

enum class MedianFilterWindow

strong

This enumeration defines the window size for median filtering.

Enumerator
Window_Size_0	Do not apply median filtering.
Window_Size_3	The window size for median filtering is 3.
Window_Size_5	The window size for median filtering is 5.
Window_Size_7	The window size for median filtering is 7.
Window_Size_9	The window size for median filtering is 9.

ProfileStrategy

enum class ProfileStrategy

strong

This enumeration defines the profile extraction strategy.

Enumerator
Standard	Select the brightest spot in each column as the profile.
Near	Select the spot closest to the camera in each column as the profile.
Far	Select the spot farthest to the camera in each column as the profile.
Continous	Not implemented.
Invalid	Discard the data of the column when multiple spots are present in the column.

ROIMode

enum class ROIMode

strong

This enumeration defines the ROI along the Z direction.

Enumerator
Mode_1_1	The ROI covers the entire image.
Mode_1_2	The ROI height is one-half of the image height.
Mode_1_4	The ROI height is one-fourth of the image height.
Mode_1_8	The ROI height is one-eighth of the image height.
Mode_1_16	The ROI height is one-sixteenth of the image height.

TriggerSource

enum class TriggerSource

strong

This enumeration defines the trigger source.

Enumerator
Software	The software trigger source.
Encoder	The Encoder trigger source.

Function Documentation

getApiInformation()

std::string MMIND_API_EXPORT getApiInformation

(

)

Gets the API basic information including version and manufacturing company.

Returns

API information string.