mvIMPACT Acquire SDK C++

Adjustment and triggering of the depth image for 3D control. More...

#include <mvIMPACT_acquire_GenICam.h>

Inheritance diagram for DepthControl:
[legend]

Public Member Functions

 DepthControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::DepthControl object.
 
HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object.
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection.
 

Public Attributes

PropertyI64 depthAcquisitionMode
 An enumerated integer property. Depth acquisition mode.
 
Method depthAcquisitionTrigger
 A method object. Triggers a depth acquisition of the device.
 
PropertyIBoolean depthDoubleShot
 A boolean property. Enables combination of disaprity images from two stereo pairs.
 
PropertyF depthExposureAdaptTimeout
 A floating point property. Maximum time in seconds to wait after triggering in SingleFrame modes until auto exposure has finished adjustments.
 
PropertyI64 depthFill
 An integer property. Higher numbers fill gaps with measurements with potentially higher errors.
 
PropertyF depthMaxDepth
 A floating point property. Maximum depth in meter. All disparities with higher depth will be set to invalid.
 
PropertyF depthMaxDepthErr
 A floating point property. Maximum depth error in meter. All disparities with a higher depth error will be set to invalid.
 
PropertyF depthMinConf
 A floating point property. Minimal confidence. All disparities with lower confidence will be set to invalid.
 
PropertyF depthMinDepth
 A floating point property. Minimum depth in meter. All disparities with lower depth will be set to invalid.
 
PropertyI64 depthQuality
 An enumerated integer property. Depth image quality (resolution).
 
PropertyI64 depthSeg
 An integer property. Maximum size of isolated disparity regions that will be invalidated, related to full resolution.
 
PropertyIBoolean depthSmooth
 A boolean property. Enables smoothing of the disparity image.
 
PropertyIBoolean depthStaticScene
 A boolean property. Enables accumulation of multiple images for noise reduction in static scenes.
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

Adjustment and triggering of the depth image for 3D control.

Adjustment and triggering of the depth image for 3D control.

Constructor & Destructor Documentation

◆ DepthControl()

DepthControl ( mvIMPACT::acquire::Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::GenICam::DepthControl object.

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]settingNameThe name of the driver internal setting to access with this instance. A list of valid setting names can be obtained by a call to mvIMPACT::acquire::FunctionInterface::getAvailableSettings, new settings can be created with the function mvIMPACT::acquire::FunctionInterface::createSetting

Member Function Documentation

◆ hObj()

HOBJ hObj ( void  ) const
inlineinherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT::acquire::ComponentList.

Returns
A unique identifier for the component referenced by this object.

◆ restoreDefault()

const ComponentCollection & restoreDefault ( void  ) const
inlineinherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note
The caller must have the right to modify the component. Otherwise an exception will be thrown.
Returns
A const reference to the component.

Member Data Documentation

◆ depthAcquisitionMode

PropertyI64 depthAcquisitionMode

An enumerated integer property. Depth acquisition mode.

Depth acquisition mode

The following string values might be valid for this feature:

  • SingleFrame (Display string: 'Single Frame'): This enumeration value sets the camera's depth acquisition mode to single frame.
  • SingleFrameOut1 (Display string: 'Single Frame Out 1'): This enumeration value sets the camera's depth acquisition mode to single frame and toggles the Out1 mode between Low and ExposureAlternateActive as needed.
  • Continuous (Display string: 'Continuous'): This enumeration value sets the camera's depth acquisition mode to continuous.
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ depthAcquisitionTrigger

Method depthAcquisitionTrigger

A method object. Triggers a depth acquisition of the device.

Triggers a depth acquisition of the device. Only relevant in SingleFrame(Out1) DepthAcquisitionMode.

◆ depthDoubleShot

PropertyIBoolean depthDoubleShot

A boolean property. Enables combination of disaprity images from two stereo pairs.

Enables combination of disaprity images from two stereo pairs.

◆ depthExposureAdaptTimeout

PropertyF depthExposureAdaptTimeout

A floating point property. Maximum time in seconds to wait after triggering in SingleFrame modes until auto exposure has finished adjustments.

Maximum time in seconds to wait after triggering in SingleFrame modes until auto exposure has finished adjustments.

◆ depthFill

PropertyI64 depthFill

An integer property. Higher numbers fill gaps with measurements with potentially higher errors.

Higher numbers fill gaps with measurements with potentially higher errors.

◆ depthMaxDepth

PropertyF depthMaxDepth

A floating point property. Maximum depth in meter. All disparities with higher depth will be set to invalid.

Maximum depth in meter. All disparities with higher depth will be set to invalid.

◆ depthMaxDepthErr

PropertyF depthMaxDepthErr

A floating point property. Maximum depth error in meter. All disparities with a higher depth error will be set to invalid.

Maximum depth error in meter. All disparities with a higher depth error will be set to invalid.

◆ depthMinConf

PropertyF depthMinConf

A floating point property. Minimal confidence. All disparities with lower confidence will be set to invalid.

Minimal confidence. All disparities with lower confidence will be set to invalid.

◆ depthMinDepth

PropertyF depthMinDepth

A floating point property. Minimum depth in meter. All disparities with lower depth will be set to invalid.

Minimum depth in meter. All disparities with lower depth will be set to invalid.

◆ depthQuality

PropertyI64 depthQuality

An enumerated integer property. Depth image quality (resolution).

Depth image quality (resolution).

The following string values might be valid for this feature:

  • Low (Display string: 'Low'): Low depth image quality.
  • Medium (Display string: 'Medium'): Medium depth image quality.
  • High (Display string: 'High'): High depth image quality.
  • Full (Display string: 'Full'): Full resolution depth image.
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ depthSeg

PropertyI64 depthSeg

An integer property. Maximum size of isolated disparity regions that will be invalidated, related to full resolution.

Maximum size of isolated disparity regions that will be invalidated, related to full resolution.

◆ depthSmooth

PropertyIBoolean depthSmooth

A boolean property. Enables smoothing of the disparity image.

Enables smoothing of the disparity image.

◆ depthStaticScene

PropertyIBoolean depthStaticScene

A boolean property. Enables accumulation of multiple images for noise reduction in static scenes.

Enables accumulation of multiple images for noise reduction in static scenes. Only applied to High and Full quality.

◆ m_hRoot

HOBJ m_hRoot
protectedinherited