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

#include <MechEyeSettings.h>

Public Attributes

std::vector< double > exposureSequence
 
double gain
 
ROI scan3DROI
 
DepthRange depthRange
 

Detailed Description

Settings used for 3D capturing.

Definition at line 44 of file MechEyeSettings.h.

Member Data Documentation

◆ depthRange

DepthRange mmind::api::Scanning3DSettings::depthRange

Depth image's valid range along Z-axis in camera coordinate system.

Pixels with depth value greater than the DepthRange::upper and less than the DepthRange::lower will be ignored.

Getter: MechEyeDevice::getDepthRange

Setter: MechEyeDevice::setDepthRange

Note
Unit: mm
Minimum: 1
Maximum: 5000

Definition at line 96 of file MechEyeSettings.h.

◆ exposureSequence

std::vector<double> mmind::api::Scanning3DSettings::exposureSequence

The exposure time sequence of the camera to capture the 3D images. Multiple exposures will produce a HDR effect.

Long exposure is often used for scanning dark objects and short exposure is often used for scanning reflective objects.

Getter: MechEyeDevice::getScan3DExposure

Setter: MechEyeDevice::setScan3DExposure

Note
Exposure unit: ms
Exposure minimum: 0.1
Exposure maximum: 99
Minimum Vector Size: 1
Maximum Vector Size: 3

Definition at line 59 of file MechEyeSettings.h.

◆ gain

double mmind::api::Scanning3DSettings::gain

Camera's gain value during scanning 3D images.

Gain is an electronic amplification of the image signal. Large gain value is needed only when scanning extremely dark objects.

Getter: MechEyeDevice::getScan3DGain

Setter: MechEyeDevice::setScan3DGain

Note
Minimum: 0
Maximum: 16

Definition at line 70 of file MechEyeSettings.h.

◆ scan3DROI

ROI mmind::api::Scanning3DSettings::scan3DROI

Depth map's ROI along height and width axes in camera coordinate system. Pixels locate out of the ROI will be ignored.

If ROI::height, ROI::width, ROI::x and ROI::y values are all zero, all pixels will be used.

Getter: MechEyeDevice::getScan3DROI

Setter: MechEyeDevice::setScan3DROI

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 84 of file MechEyeSettings.h.


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