Data structures

Classes
struct	STRUCT_POINT
	Defines a point received by a callback handler for (ProfileCallback). More...
struct	HEADER
	Header associated to each raw image or profile received from the camera. More...
struct	FieldCalibrationResults
struct	DynSensorControl
	Stucture hold dynamic sensor control parameters. More...

Macros
#define	FS_HEADER_INPUT_STATE_BIT   (1 << 0)
	Position of input state enable bit inside HEADER::enabled_fields. More...
#define	FS_HEADER_PULSE_WIDTH_BIT   (1 << 1)
	Position of pulse width enable bit inside HEADER::enabled_fields. More...
#define	FS_HEADER_LOCATION_BIT   (1 << 2)
	Position of location enable bit inside HEADER::enabled_fields. More...
#define	BIT_SET(field, bit)   (field |= bit)
	Sets a bit inside a bitfield. More...
#define	BIT_CLEAR(field, bit)   (field &= ~bit)
	Clears a bit inside a bitfield. More...
#define	BIT_IS_SET(field, bit)   (field & bit)
	Checks if a bit inside field is set. More...
#define	NO_MEASUREMENT   (float)(9999999)
	Not measured point in line and batch callback functions More...
#define	MAX_LAYERS   10
	Maximum number of layers More...
#define	NOT_MEASURED_POINT(x)   ((x)>9999998)
	Macro to check whether the point is measured or not More...
#define	MAX_GROOVE_MEASUREMENTS   5
	Results of field calibration function. Measurements in micrometers. More...

Enumerations
enum	InterleavePhase { Long =0, Short = 1 }
	Enumeration for the interleaving phase. More...
enum	SurfaceSorting { FROM_TOP_TO_BOTTOM =0, FROM_BOTTOM_TO_TOP =1, FROM_MAX_INTENSITY_TO_LOWER =2, FROM_MAX_INTENSITY_TO_LOWER_AND_TOP_TO_BOTTOM = 3 }
enum	MaterialType { Opaque = 0, Mirror = 1, Transparent = 2 }
	Enumeration for the material type. More...
enum	DetectionSensitivity { BestAccuracy = 0, BestSensitivity = 1 }
	Enumeration for sensitivity used in peak detection configuration. More...
enum	ZCompensationCalibrationStatus {   NotStarted = 0, Waiting = 1, Scanning = 2, Completed = 3,   ProfilesMissing = 4, NotMeasuredPoints = 5, TextureNotFound = 6, DuplicateHeight = 7 }
	Enumeration for status in ZCompensationCalibration. More...

Detailed Description

Macro Definition Documentation

BIT_CLEAR

#define BIT_CLEAR	(		field,
			bit
	)		(field &= ~bit)

Clears a bit inside a bitfield.

BIT_IS_SET

#define BIT_IS_SET	(		field,
			bit
	)		(field & bit)

Checks if a bit inside field is set.

BIT_SET

#define BIT_SET	(		field,
			bit
	)		(field |= bit)

Sets a bit inside a bitfield.

FS_HEADER_INPUT_STATE_BIT

#define FS_HEADER_INPUT_STATE_BIT   (1 << 0)

Position of input state enable bit inside HEADER::enabled_fields.

FS_HEADER_LOCATION_BIT

#define FS_HEADER_LOCATION_BIT   (1 << 2)

Position of location enable bit inside HEADER::enabled_fields.

FS_HEADER_PULSE_WIDTH_BIT

#define FS_HEADER_PULSE_WIDTH_BIT   (1 << 1)

Position of pulse width enable bit inside HEADER::enabled_fields.

MAX_GROOVE_MEASUREMENTS

#define MAX_GROOVE_MEASUREMENTS   5

Results of field calibration function. Measurements in micrometers.

MAX_LAYERS

#define MAX_LAYERS   10

Maximum number of layers

NO_MEASUREMENT

#define NO_MEASUREMENT   (float)(9999999)

Not measured point in line and batch callback functions

NOT_MEASURED_POINT

#define NOT_MEASURED_POINT

(

x

)

((x)>9999998)

Macro to check whether the point is measured or not

Enumeration Type Documentation

DetectionSensitivity

enum DetectionSensitivity

Enumeration for sensitivity used in peak detection configuration.

Enumerator
BestAccuracy	BestAccuracy is used when when the accuracy is prioritized.
BestSensitivity	BestSensitivity used when dark areas need to be detected.

InterleavePhase

enum InterleavePhase

Enumeration for the interleaving phase.

Enumerator
Long	Peak is taken with long exposure time.
Short	Peak is taken with short exposure time.

MaterialType

enum MaterialType

Enumeration for the material type.

Enumerator
Opaque	Opaque is used when a top surface has opaque areas.
Mirror	Mirror is used for highly reflective surfaces.
Transparent	Transparent is used for materials having transparent surfaces.

SurfaceSorting

enum SurfaceSorting

Enumerator
FROM_TOP_TO_BOTTOM	Sorting layers from top to bottom
FROM_BOTTOM_TO_TOP	Sorting layers from bottom to top
FROM_MAX_INTENSITY_TO_LOWER	Sorting layers according to intensity value. Highest intensity is layer 0.
FROM_MAX_INTENSITY_TO_LOWER_AND_TOP_TO_BOTTOM	Sorting layers according to intensity value and then from top to bottom.

ZCompensationCalibrationStatus

enum ZCompensationCalibrationStatus

Enumeration for status in ZCompensationCalibration.

Enumerator
NotStarted	State when system is not started.
Waiting	State when a new scan is requested by UI.
Scanning	Scanning.
Completed	Scanning completed successfully.
ProfilesMissing	Scanning completed but profiles were missing. Probably moving speed was too high for the sensor.
NotMeasuredPoints	Scanning completed but points were missing. Probably led pulse length was too low.
TextureNotFound	Scanning completed but proper texture was not found from the measurement.
DuplicateHeight	Scanning completed but a duplicate height was found.