Mech-Eye API 2.4.0
API reference documentation for Mech-Eye Industrial 3D Camera
Loading...
Searching...
No Matches
Public Types | Public Attributes | List of all members
mmind::api::Scanning2DSettings Struct Reference

#include <MechEyeSettings.h>

Public Types

enum  Scan2DExposureMode { Timed , Auto , HDR , Flash }
 

Public Attributes

Scan2DExposureMode exposureMode
 
double exposureTime
 The fixed camera exposure time.
 
double sharpenFactor
 
int expectedGrayValue
 
ROI scan2DROI
 
bool toneMappingEnable
 
std::vector< double > hdrExposureSequence
 

Detailed Description

Settings used for ColorMap capturing.

Definition at line 102 of file MechEyeSettings.h.

Member Enumeration Documentation

◆ Scan2DExposureMode

Option for exposure mode.

Enumerator
Timed 

Fixed exposure time, recommended in the stable ambient light conditions.

Auto 

Automatic exposure time, recommended in unstable ambient light conditions.

HDR 

Generate images of high dynamic ranges showing more details with multiple different exposures.

Flash 

Use projected LED light to light up the projection area.

Definition at line 107 of file MechEyeSettings.h.

Member Data Documentation

◆ expectedGrayValue

int mmind::api::Scanning2DSettings::expectedGrayValue

The expected image gray value.

Only take effect in Auto mode.

A smaller value can decrease the brightness of the image, while a larger value can generate a brighter image.

Getter: MechEyeDevice::getScan2DExpectedGrayValue

Setter: MechEyeDevice::setScan2DExpectedGrayValue

Note
Minimum: 0
Maximum: 255

Definition at line 153 of file MechEyeSettings.h.

◆ exposureMode

Scan2DExposureMode mmind::api::Scanning2DSettings::exposureMode

Option for exposure mode.

Definition at line 118 of file MechEyeSettings.h.

◆ exposureTime

double mmind::api::Scanning2DSettings::exposureTime

The fixed camera exposure time.

Only take effect in Timed mode.

Getter: MechEyeDevice::getScan2DExposureTime

Setter: MechEyeDevice::setScan2DExposureTime

Note
Unit: ms
Minimum: 0.1
Maximum: 999

Definition at line 129 of file MechEyeSettings.h.

◆ hdrExposureSequence

std::vector<double> mmind::api::Scanning2DSettings::hdrExposureSequence

A sequence of camera exposures used for HDR capturing.

Only take effect in HDR mode.

Getter: MechEyeDevice::getScan2DHDRExposureSequence

Setter: MechEyeDevice::setScan2DHDRExposureSequence

Note
Exposure unit: ms
Exposure minimum: 0.1
Exposure maximum: 999
Minimum Vector Size: 1
Maximum Vector Size: 5

Definition at line 186 of file MechEyeSettings.h.

◆ scan2DROI

ROI mmind::api::Scanning2DSettings::scan2DROI

Camera's ROI when scanning 2D images

Only take effect in Auto and HDR mode.

Getter: MechEyeDevice::getScan2DROI

Setter: MechEyeDevice::setScan2DROI

Note
ROI::x must be less than the number of columns in the image.
ROI::y must be less than the number of rows in the image.
ROI::width must be less than the width of the image.
ROI::height must be less than the height of the image.

Definition at line 165 of file MechEyeSettings.h.

◆ sharpenFactor

double mmind::api::Scanning2DSettings::sharpenFactor

The image sharpen factor.

Take effect in all Scan2DExposureMode mode.

Use sharpening algorithm to get sharp edge details, it may cause image noise. The higher the value, the higher the image sharpness.

Getter: MechEyeDevice::getScan2DSharpenFactor

Setter: MechEyeDevice::setScan2DSharpenFactor

Note
Minimum: 0
Maximum: 5

Definition at line 141 of file MechEyeSettings.h.

◆ toneMappingEnable

bool mmind::api::Scanning2DSettings::toneMappingEnable

Use gray level transformation algorithm to make the image look more natural.

Only take effect in HDR mode.

Getter: MechEyeDevice::getScan2DToneMappingEnable

Setter: MechEyeDevice::setScan2DToneMappingEnable

Definition at line 173 of file MechEyeSettings.h.


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