| MikroCAD SDK Library

- Home
- All Types
- Files

All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Macros | Typedefs | Enums
MeasurementDefs.h File Reference

## Description

Defines for measurement module for sensors with 1 projector and 1 camera.

Author
  LMI Technologies

Go to the source code of this file.

## Macros
#define | MEAS_PARAMETER_AVAILABLE_READ 1
| Measurement parameter is available to read.
#define | MEAS_PARAMETER_AVAILABLE_WRITE 2
| Measurement parameter is available to write.
#define | MEAS_PARAMETER_NOT_AVAILABLE 0
| Parameter setting. More...
#define | SENSOR_EVENT_RETURN_VALUE_BUFFER_SIZE 10240
| Trigger event buffer size. More...
#define | SIMPLE_CALIB_STATE_NONE 0
| Calibration states.

## Typedefs
typedef void(__stdcall * | COMM_ERROR )()
| Callback prototype for MikroCAD_SetUSBCommErrorHandler.
typedef vector< unsigned long > | TDWordList
| Double word list.
typedef vector< string > | TStringList
| String list.

## Enums
enum | CalibrationMeasProgram { CalibrationMeasProgram_32_8, CalibrationMeasProgram_32_16, CalibrationMeasProgram_32_32, CalibrationMeasProgram_32_64, CalibrationMeasProgram_32_128 }
| Measuring program for calibration. More...
enum | CalibrationMode { CalibrationMode_None = 0, CalibrationMode_Simple = 1, CalibrationMode_MultiLevel = 2 }
| Calibration modes. More...
enum | CalibrationType
| Calibration types.
enum | CameraDriverTypeID { CameraDriverTypeID_None = 0, CameraDriverTypeID_Pylon1394 = 1, CameraDriverTypeID_PylonGigE = 2, CameraDriverTypeID_Vimba = 3 }
| Cameras driver type (Pylon, Vimba...) More...
enum | ConfigDataTransferMode { ConfigDataTransferMode_InitialParameter, ConfigDataTransferMode_MeasProgramSet, ConfigDataTransferMode_Calibration, ConfigDataTransferMode_AllWithoutCalibration = 0xfffe, ConfigDataTransferMode_All = 0xffff }
| Configuration data transfer mode. More...
enum | MeasurementMode { MeasurementMode_None = 0, MeasurementMode_GrayCodePhaseShift = 1, MeasurementMode_PhaseShift = 2, MeasurementMode_PhaseCode = 3 }
| Measurement mode. More...
enum | MeasurementParameterID { MeasurementParameterID_CurrCameraSizeX = 0, MeasurementParameterID_CurrCameraSizeY = 1, MeasurementParameterID_CurrCameraX0 = 2, MeasurementParameterID_CurrCameraY0 = 3, MeasurementParameterID_MaxCameraSizeX = 4, MeasurementParameterID_MaxCameraSizeY = 5, MeasurementParameterID_CurrProjectorSizeX = 10, MeasurementParameterID_CurrProjectorSizeY = 11, MeasurementParameterID_CurrProjectorX0 = 12, MeasurementParameterID_CurrProjectorY0 = 13, MeasurementParameterID_MaxProjectorSizeX = 14, MeasurementParameterID_MaxProjectorSizeY = 15, MeasurementParameterID_CameraShutter = 101, MeasurementParameterID_CameraShutterTimeBase = 102, MeasurementParameterID_CameraGain = 103, MeasurementParameterID_ProjectorBrightness = 151, MeasurementParameterID_ProjectorSwitchOnOff = 152, MeasurementParameterID_SensorBrightness = 160, MeasurementParameterID_Dynamic = 165, MeasurementParameterID_BrightnessOffsetHDRMode = 166, MeasurementParameterID_BrightnessOffsetSuperHDRMode = 167, MeasurementParameterID_SensorSwitchOnOff = 201, MeasurementParameterID_UseTexture = 801, MeasurementParameterID_MirrorMode = 821, MeasurementParameterID_NumPattern = 901, MeasurementParameterID_NumStripes = 902, MeasurementParameterID_TextureCorrFactorRed = 802, MeasurementParameterID_TextureCorrFactorGreen = 803, MeasurementParameterID_TextureCorrFactorBlue = 804, MeasurementParameterID_TextureCorrFactorBrightness = 805, MeasurementParameterID_ScaleX = 1000, MeasurementParameterID_ScaleY = 1001, MeasurementParameterID_ScaleZ = 1002, MeasurementParameterID_MaxProjectionAreaX = 1011, MeasurementParameterID_MaxProjectionAreaY = 1012, Measurement_ParameterID_LEDTemperature = 2001, Measurement_ParameterID_SystemTemperature = 2002, Measurement_ParameterID_ProjectorStatus = 2003 }
| Parameter IDs. More...
enum | MeasurementPattern { MeasurementPattern_Bright = 0, MeasurementPattern_Dark = 1, MeasurementPattern_MeasRange = 2, MeasurementPattern_Sqare = 3, MeasurementPattern_Circle = 4, MeasurementPattern_SqareCross = 5, MeasurementPattern_CircleCross = 6 }
| Pattern types. More...
enum | MeasurementPreFilterType { MeasurementPreFilterType_None = 0, MeasurementPreFilterType_RemoveInvalid = 1, MeasurementPreFilterType_Gaussian = 2, MeasurementPreFilterType_Average = 3, MeasurementPreFilterType_Median = 4, MeasurementPreFilterType_RemovePeaks = 5, MeasurementPreFilterType_Last }
| Prefilter type. More...
enum | MeasurementStripePattern { , MeasurementStripePattern_1 = 1, MeasurementStripePattern_2 = 2, MeasurementStripePattern_4 = 3, MeasurementStripePattern_8 = 4, MeasurementStripePattern_16 = 5, MeasurementStripePattern_32 = 6, MeasurementStripePattern_64 = 7, MeasurementStripePattern_128 = 8, MeasurementStripePattern_256 = 9, MeasurementStripePattern_512 = 10, MeasurementStripePattern_1024 = 11 }
| Stripes types. More...
enum | MeasurementTextureMode
| Texture mode (Gray or color projection)
enum | ProjectorDriverTypeID { ProjectorDriverTypeID_None = 0, ProjectorDriverTypeID_Alligator = 1 }
| Sensor with separate camera and projector. More...
enum | ProjectorLampState { ProjectorLampState_Indefinite, ProjectorLampState_On, ProjectorLampState_Off }
| Projector lamp state. More...
enum | ProjectorPositionToCamera
| Projector position to camera.
enum | SensorEventReturnType { SensorEventReturnType_None = 0, SensorEventReturnType_Int = 1, SensorEventReturnType_Float = 2, SensorEventReturnType_String = 3 }
| Trigger events return types. More...
enum | SensorEventType { SensorEventType_None = 0, SensorEventType_ProjectionEnd = 1, SensorEventType_ExternalTrigger = 2 }
| Trigger event types. More...
enum | SensorOperatingMode { SensorOperatingMode_Measure = 0, SensorOperatingMode_SimpleCalib = 1 }
| Sensor operating mode. More...
enum | SensorTypeID { SensorTypeID_None = 0, SensorTypeID_DSP = 2, SensorTypeID_AlligatorPylon1394 = 3, SensorTypeID_AlligatorPylonGigE = 4, SensorTypeID_AlligatorVimba = 5 }
| List of the IDs of all available sensor types. More...

## Macro Definition Documentation

#define MEAS_PARAMETER_NOT_AVAILABLE 0

Parameter setting.

Available flagsMeasurement parameter not available

#define SENSOR_EVENT_RETURN_VALUE_BUFFER_SIZE 10240

Trigger event buffer size.

Buffer size

## Enum Fields

enum CalibrationMeasProgram

Measuring program for calibration.

Enumerator
CalibrationMeasProgram_32_8 | Stripes width 32, 8 images.
CalibrationMeasProgram_32_16 | Stripes width 32, 16 images.
CalibrationMeasProgram_32_32 | Stripes width 32, 32 images.
CalibrationMeasProgram_32_64 | Stripes width 32, 64 images.
CalibrationMeasProgram_32_128 | Stripes width 32, 128 images.

enum CalibrationMode

Calibration modes.

Enumerator
CalibrationMode_None | No calibration.
CalibrationMode_Simple | Simple calibration.
CalibrationMode_MultiLevel | Multi level calibration.

enum CameraDriverTypeID

Cameras driver type (Pylon, Vimba...)

Enumerator
CameraDriverTypeID_None | No camera.
CameraDriverTypeID_Pylon1394 | Pylon Basler (IEEE 1394)
CameraDriverTypeID_PylonGigE | Pylon Basler (GigE)
CameraDriverTypeID_Vimba | Vimba AVT.

enum ConfigDataTransferMode

Configuration data transfer mode.

Enumerator
ConfigDataTransferMode_InitialParameter | Initial parameters.
ConfigDataTransferMode_MeasProgramSet | Measurement program set.
ConfigDataTransferMode_Calibration | Calibration.
ConfigDataTransferMode_AllWithoutCalibration | All without calibration.
ConfigDataTransferMode_All | All.

enum MeasurementMode

Measurement mode.

Enumerator
MeasurementMode_None | No measurement mode.
MeasurementMode_GrayCodePhaseShift | Gray code + phase shift.
MeasurementMode_PhaseShift | Phase shift only.
MeasurementMode_PhaseCode | Phase code.

enum MeasurementParameterID

Parameter IDs.

Enumerator
MeasurementParameterID_CurrCameraSizeX | Integer parameter. Current camera size in X direction (in pixel)
MeasurementParameterID_CurrCameraSizeY | Current camera size in Y direction (in pixel)
MeasurementParameterID_CurrCameraX0 | Current camera origin in X direction (in pixel)
MeasurementParameterID_CurrCameraY0 | Current camera origin in Y direction (in pixel)
MeasurementParameterID_MaxCameraSizeX | Maximum camera size in X direction (in pixel)
MeasurementParameterID_MaxCameraSizeY | Maximum camera size in Y direction (in pixel)
MeasurementParameterID_CurrProjectorSizeX | Current projector size in X direction (in pixel)
MeasurementParameterID_CurrProjectorSizeY | Current projector size in Y direction (in pixel)
MeasurementParameterID_CurrProjectorX0 | Current projector origin in X direction (in pixel)
MeasurementParameterID_CurrProjectorY0 | Current projector origin in Y direction (in pixel)
MeasurementParameterID_MaxProjectorSizeX | Maximum projector size in X direction (in pixel)
MeasurementParameterID_MaxProjectorSizeY | Maximum projector size in Y direction (in pixel)
MeasurementParameterID_CameraShutter | Camera shutter.
MeasurementParameterID_CameraShutterTimeBase | Camera shutter time base.
MeasurementParameterID_CameraGain | Camera gain.
MeasurementParameterID_ProjectorBrightness | Projector brightness (e.g. LED power)
MeasurementParameterID_ProjectorSwitchOnOff | Projector switch on/off.
MeasurementParameterID_SensorBrightness | Sensor brightness combined from camera shutter, camera gain, projector brightness ...
MeasurementParameterID_Dynamic | Dynamic - measurement with 2 or 3 brightness parameter sets (HDR mode , Super HDR mode)
MeasurementParameterID_BrightnessOffsetHDRMode | Brightness offset for HDR mode (Dynamic 2)
MeasurementParameterID_BrightnessOffsetSuperHDRMode | Brightness offset for Super HDR mode (Dynamic 3)
MeasurementParameterID_SensorSwitchOnOff | Sensor switch on/off.
MeasurementParameterID_UseTexture | Use texture acquisition ?
MeasurementParameterID_MirrorMode | Mirror mode for all images.
MeasurementParameterID_NumPattern | Number of predefined pattern.
MeasurementParameterID_NumStripes | Number of predefined stripe pattern.
MeasurementParameterID_TextureCorrFactorRed | Float parameter.
MeasurementParameterID_TextureCorrFactorGreen | Color factor red share (only Texture mode "projection color".
MeasurementParameterID_TextureCorrFactorBlue | Color factor green share (only Texture mode "projection color".
MeasurementParameterID_TextureCorrFactorBrightness | Color factor blue share (only Texture mode "projection color".
MeasurementParameterID_ScaleX | Brightness factor for texture (all modes) Scaling X
MeasurementParameterID_ScaleY | Scaling Y.
MeasurementParameterID_ScaleZ | Scaling Z.
MeasurementParameterID_MaxProjectionAreaX | Maximum of projection area percental X.
MeasurementParameterID_MaxProjectionAreaY | Maximum of projection area percental Y.
Measurement_ParameterID_LEDTemperature | LED temperature, only available on some systems.
Measurement_ParameterID_SystemTemperature | System/Camera temperature, only available on some systems.
Measurement_ParameterID_ProjectorStatus | Projector status, only available on some systems.

enum MeasurementPattern

Pattern types.

Enumerator
MeasurementPattern_Bright | Bright image (255)
MeasurementPattern_Dark | Dark image (0)
MeasurementPattern_MeasRange | Measurement range.
MeasurementPattern_Sqare | Square.
MeasurementPattern_Circle | Circle.
MeasurementPattern_SqareCross | Square with cross.
MeasurementPattern_CircleCross | Circle with cross.

enum MeasurementPreFilterType

Prefilter type.

Enumerator
MeasurementPreFilterType_None | No type.
MeasurementPreFilterType_RemoveInvalid | Remove invalid values.
MeasurementPreFilterType_Gaussian | Gaussian filter.
MeasurementPreFilterType_Average | Average filter.
MeasurementPreFilterType_Median | Median filter.
MeasurementPreFilterType_RemovePeaks | Remove peaks.
MeasurementPreFilterType_Last | Last item.

enum MeasurementStripePattern

Stripes types.

Enumerator
MeasurementStripePattern_1 | No stripes, bright image (255 or invers 0)
MeasurementStripePattern_2 | 1 stripe
MeasurementStripePattern_4 | 2 stripes
MeasurementStripePattern_8 | 4 stripes
MeasurementStripePattern_16 | 5 stripes
MeasurementStripePattern_32 | 16 stripes
MeasurementStripePattern_64 | 32 stripes
MeasurementStripePattern_128 | 64 stripes
MeasurementStripePattern_256 | 128 stripes
MeasurementStripePattern_512 | 256 stripes
MeasurementStripePattern_1024 | 512 stripes

enum ProjectorDriverTypeID

Sensor with separate camera and projector.

Projector driver type (Alligator...)

Enumerator
ProjectorDriverTypeID_None | No projector.
ProjectorDriverTypeID_Alligator | Alligator.

enum ProjectorLampState

Projector lamp state.

Enumerator
ProjectorLampState_Indefinite | Indefinite - No projector lamp switch on / off possible.
ProjectorLampState_On | Lamp on.
ProjectorLampState_Off | Lamp off.

enum SensorEventReturnType

Trigger events return types.

Enumerator
SensorEventReturnType_None | No return.
SensorEventReturnType_Int | Integer.
SensorEventReturnType_Float | Double.
SensorEventReturnType_String | Zero terminated string.

enum SensorEventType

Trigger event types.

Enumerator
SensorEventType_None | No event type.
SensorEventType_ProjectionEnd | Called on projection end.
SensorEventType_ExternalTrigger | Called on external trigger event.

enum SensorOperatingMode

Sensor operating mode.

Enumerator
SensorOperatingMode_Measure | Initialized for measurements only.
SensorOperatingMode_SimpleCalib | Initialized for simple calibration and measurement.

enum SensorTypeID

List of the IDs of all available sensor types.

Enumerator
SensorTypeID_None | No type.
SensorTypeID_DSP | DSP sensor.
SensorTypeID_AlligatorPylon1394 | Sensor Projector: Alligator, Camera Pylon Basler IEEE1394.
SensorTypeID_AlligatorPylonGigE | Sensor Projector: Alligator, Camera Pylon Basler GigE.
SensorTypeID_AlligatorVimba | Sensor Projector: Alligator, Camera Vimba AVT.