DepthControl Class Reference

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

Inheritance diagram for DepthControl:

Public Member Functions
	__init__ (self, *args)
	Constructs a new mvIMPACT.acquire.DepthControl object.

Properties
	depthAcquisitionMode = property(lib_mvIMPACT_acquire.DepthControl_depthAcquisitionMode_get, doc=)
	An enumerated integer property.
	depthAcquisitionTrigger = property(lib_mvIMPACT_acquire.DepthControl_depthAcquisitionTrigger_get, doc=)
	A method object.
	depthDoubleShot = property(lib_mvIMPACT_acquire.DepthControl_depthDoubleShot_get, doc=)
	A boolean property.
	depthExposureAdaptTimeout = property(lib_mvIMPACT_acquire.DepthControl_depthExposureAdaptTimeout_get, doc=)
	A floating point property.
	depthFill = property(lib_mvIMPACT_acquire.DepthControl_depthFill_get, doc=)
	An integer property.
	depthMaxDepth = property(lib_mvIMPACT_acquire.DepthControl_depthMaxDepth_get, doc=)
	A floating point property.
	depthMaxDepthErr = property(lib_mvIMPACT_acquire.DepthControl_depthMaxDepthErr_get, doc=)
	A floating point property.
	depthMinConf = property(lib_mvIMPACT_acquire.DepthControl_depthMinConf_get, doc=)
	A floating point property.
	depthMinDepth = property(lib_mvIMPACT_acquire.DepthControl_depthMinDepth_get, doc=)
	A floating point property.
	depthQuality = property(lib_mvIMPACT_acquire.DepthControl_depthQuality_get, doc=)
	An enumerated integer property.
	depthSeg = property(lib_mvIMPACT_acquire.DepthControl_depthSeg_get, doc=)
	An integer property.
	depthSmooth = property(lib_mvIMPACT_acquire.DepthControl_depthSmooth_get, doc=)
	A boolean property.
	depthStaticScene = property(lib_mvIMPACT_acquire.DepthControl_depthStaticScene_get, doc=)
	A boolean property.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

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

__init__()

__init__	(		self,
		*	args )

Constructs a new mvIMPACT.acquire.DepthControl object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
settingName	[in] The 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

Reimplemented from ComponentCollection.

Property Documentation

depthAcquisitionMode

depthAcquisitionMode = property(lib_mvIMPACT_acquire.DepthControl_depthAcquisitionMode_get, doc=)

static

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.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

depthAcquisitionTrigger

depthAcquisitionTrigger = property(lib_mvIMPACT_acquire.DepthControl_depthAcquisitionTrigger_get, doc=)

static

A method object.

Triggers a depth acquisition of the device.

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

depthDoubleShot

depthDoubleShot = property(lib_mvIMPACT_acquire.DepthControl_depthDoubleShot_get, doc=)

static

A boolean property.

Enables combination of disaprity images from two stereo pairs.

Enables combination of disaprity images from two stereo pairs.

depthExposureAdaptTimeout

depthExposureAdaptTimeout = property(lib_mvIMPACT_acquire.DepthControl_depthExposureAdaptTimeout_get, doc=)

static

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

depthFill = property(lib_mvIMPACT_acquire.DepthControl_depthFill_get, doc=)

static

An integer property.

Higher numbers fill gaps with measurements with potentially higher errors.

Higher numbers fill gaps with measurements with potentially higher errors.

depthMaxDepth

depthMaxDepth = property(lib_mvIMPACT_acquire.DepthControl_depthMaxDepth_get, doc=)

static

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

depthMaxDepthErr = property(lib_mvIMPACT_acquire.DepthControl_depthMaxDepthErr_get, doc=)

static

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

depthMinConf = property(lib_mvIMPACT_acquire.DepthControl_depthMinConf_get, doc=)

static

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

depthMinDepth = property(lib_mvIMPACT_acquire.DepthControl_depthMinDepth_get, doc=)

static

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

depthQuality = property(lib_mvIMPACT_acquire.DepthControl_depthQuality_get, doc=)

static

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.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

depthSeg

depthSeg = property(lib_mvIMPACT_acquire.DepthControl_depthSeg_get, doc=)

static

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

depthSmooth = property(lib_mvIMPACT_acquire.DepthControl_depthSmooth_get, doc=)

static

A boolean property.

Enables smoothing of the disparity image.

Enables smoothing of the disparity image.

depthStaticScene

depthStaticScene = property(lib_mvIMPACT_acquire.DepthControl_depthStaticScene_get, doc=)

static

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.

thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static