DepthControl Class Reference

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

Inheritance diagram for DepthControl:

Public Member Functions
	DepthControl (mv.impact.acquire.Device device)
	Constructs a new mv.impact.acquire.GenICam.DepthControl object.
	DepthControl (mv.impact.acquire.Device device, System.String settingName)
	Constructs a new mv.impact.acquire.GenICam.DepthControl object.
IEnumerable< T >	getEnumerable< T > ()
	Returns an enumerator of a certain type that iterates through the collection.
IEnumerator< int >	GetEnumerator ()
	Returns an enumerator that iterates through the collection.
void	restoreDefault ()
	Restores the default for every component of this collection.

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

Properties
IEnumerable< Component >	componentEnumerable [get]
	Returns an enumerator that iterates through the collection.
IEnumerable< ComponentList >	componentListEnumerable [get]
	Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.
int	hObj [get]
	Returns a unique identifier for the component collection referenced by this object.

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/2]

DepthControl ( mv::impact::acquire::Device device )

inline

Constructs a new mv.impact.acquire.GenICam.DepthControl object.

Parameters

[in]

device

A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

DepthControl() [2/2]

DepthControl ( mv::impact::acquire::Device device, System::String settingName )

inline

Constructs a new mv.impact.acquire.GenICam.DepthControl object.

Parameters

[in]	device	A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.
[in]	settingName	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 mv.impact.acquire.FunctionInterface.availableSettings, new settings can be created with the function mv.impact.acquire.FunctionInterface.createSetting

Member Function Documentation

getEnumerable< T >()

IEnumerable< T > getEnumerable< T > ( )

inlineinherited

Returns an enumerator of a certain type that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Property c in info.getEnumerable<Property>())
{
  validateProperty(c);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

GetEnumerator()

IEnumerator< int > GetEnumerator ( )

inlineinherited

Returns an enumerator that iterates through the collection.

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

restoreDefault()

void restoreDefault ( )

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.

Member Data Documentation

depthAcquisitionMode

readonly mv.impact.acquire.PropertyI64 depthAcquisitionMode = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

depthAcquisitionTrigger

readonly mv.impact.acquire.Method depthAcquisitionTrigger = new mv.impact.acquire.Method()

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

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

depthDoubleShot

readonly mv.impact.acquire.PropertyIBoolean depthDoubleShot = new mv.impact.acquire.PropertyIBoolean()

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

Enables combination of disaprity images from two stereo pairs.

depthExposureAdaptTimeout

readonly mv.impact.acquire.PropertyF depthExposureAdaptTimeout = new mv.impact.acquire.PropertyF()

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

readonly mv.impact.acquire.PropertyI64 depthFill = new mv.impact.acquire.PropertyI64()

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

Higher numbers fill gaps with measurements with potentially higher errors.

depthMaxDepth

readonly mv.impact.acquire.PropertyF depthMaxDepth = new mv.impact.acquire.PropertyF()

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

readonly mv.impact.acquire.PropertyF depthMaxDepthErr = new mv.impact.acquire.PropertyF()

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

readonly mv.impact.acquire.PropertyF depthMinConf = new mv.impact.acquire.PropertyF()

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

readonly mv.impact.acquire.PropertyF depthMinDepth = new mv.impact.acquire.PropertyF()

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

readonly mv.impact.acquire.PropertyI64 depthQuality = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

depthSeg

readonly mv.impact.acquire.PropertyI64 depthSeg = new mv.impact.acquire.PropertyI64()

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

readonly mv.impact.acquire.PropertyIBoolean depthSmooth = new mv.impact.acquire.PropertyIBoolean()

A boolean property. Enables smoothing of the disparity image.

Enables smoothing of the disparity image.

depthStaticScene

readonly mv.impact.acquire.PropertyIBoolean depthStaticScene = new mv.impact.acquire.PropertyIBoolean()

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.

Property Documentation

componentEnumerable

IEnumerable<Component> componentEnumerable

getinherited

Returns an enumerator that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Component c in info.componentEnumerable)
{
  Console.WriteLine("{0}", c.name);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

componentListEnumerable

IEnumerable<ComponentList> componentListEnumerable

getinherited

Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (ComponentList cl in info.componentListEnumerable)
{
  Console.WriteLine("{0}", cl.name);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

hObj

int hObj

getinherited

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

This handle will always reference an object of type mv.impact.acquire.ComponentList.

Returns

A unique identifier for the component referenced by this object.