Struct Scanning2DSettings

Struct Documentation

struct mmind::api::Scanning2DSettings

Settings used for ColorMap capturing.

Public Types

enum Scan2DExposureMode

Option for exposure mode.

Values:

enumerator Timed

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

enumerator Auto

Automatic exposure time, recommended in unstable ambient light conditions.

enumerator HDR

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

enumerator Flash

Use projected LED light to light up the projection area.

Public Members

Scan2DExposureMode exposureMode

Option for exposure mode.

double 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

double 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

int 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

ROI 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.

bool 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

std::vector<double> 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