DepthControl Class Reference

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

Inheritance diagram for DepthControl:

Public Member Functions
synchronized void	delete ()
	DepthControl (Device pDev)
	Constructs a new mvIMPACT.acquire.DepthControl object.
	DepthControl (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.DepthControl object.
PropertyI64	getDepthAcquisitionMode ()
	An enumerated integer property.
Method	getDepthAcquisitionTrigger ()
	A method object.
PropertyI	getDepthDoubleShot ()
	A boolean property.
PropertyF	getDepthExposureAdaptTimeout ()
	A floating point property.
PropertyI64	getDepthFill ()
	An integer property.
PropertyF	getDepthMaxDepth ()
	A floating point property.
PropertyF	getDepthMaxDepthErr ()
	A floating point property.
PropertyF	getDepthMinConf ()
	A floating point property.
PropertyF	getDepthMinDepth ()
	A floating point property.
PropertyI64	getDepthQuality ()
	An enumerated integer property.
PropertyI64	getDepthSeg ()
	An integer property.
PropertyI	getDepthSmooth ()
	A boolean property.
PropertyI	getDepthStaticScene ()
	A boolean property.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
	DepthControl (long cPtr, boolean cMemoryOwn)
void	finalize ()

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)
static long	swigRelease (DepthControl obj)

Protected Attributes
transient boolean	swigCMemOwn

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() [1/3]

DepthControl ( long cPtr, boolean cMemoryOwn )

protected

DepthControl() [2/3]

DepthControl	(	Device	pDev,
		String	settingName )

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

DepthControl() [3/3]

DepthControl

(

Device

pDev

)

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

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getDepthAcquisitionMode()

PropertyI64 getDepthAcquisitionMode

(

)

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.

getDepthAcquisitionTrigger()

Method getDepthAcquisitionTrigger

(

)

A method object.

Triggers a depth acquisition of the device.

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

getDepthDoubleShot()

PropertyI getDepthDoubleShot

(

)

A boolean property.

Enables combination of disaprity images from two stereo pairs.

Enables combination of disaprity images from two stereo pairs.

getDepthExposureAdaptTimeout()

PropertyF getDepthExposureAdaptTimeout

(

)

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.

getDepthFill()

PropertyI64 getDepthFill

(

)

An integer property.

Higher numbers fill gaps with measurements with potentially higher errors.

Higher numbers fill gaps with measurements with potentially higher errors.

getDepthMaxDepth()

PropertyF getDepthMaxDepth

(

)

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.

getDepthMaxDepthErr()

PropertyF getDepthMaxDepthErr

(

)

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.

getDepthMinConf()

PropertyF getDepthMinConf

(

)

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.

getDepthMinDepth()

PropertyF getDepthMinDepth

(

)

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.

getDepthQuality()

PropertyI64 getDepthQuality

(

)

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.

getDepthSeg()

PropertyI64 getDepthSeg

(

)

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.

getDepthSmooth()

PropertyI getDepthSmooth

(

)

A boolean property.

Enables smoothing of the disparity image.

Enables smoothing of the disparity image.

getDepthStaticScene()

PropertyI getDepthStaticScene

(

)

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.

hObj()

int hObj ( )

inherited

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()

ComponentCollection restoreDefault ( )

inherited

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.

swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

swigRelease() [2/2]

static long swigRelease ( DepthControl obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited