mvAutoFeatureControl Class Reference

Contains features to control the image controllers. The properties are applied to Auto Gain Control(AGC) and Auto Exposure Control(AEC) controller. To take effect at least AEC or AGC must be enabled. More...

Inheritance diagram for mvAutoFeatureControl:

Public Member Functions
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.
	mvAutoFeatureControl (mv.impact.acquire.Device device)
	Constructs a new mv.impact.acquire.GenICam.mvAutoFeatureControl object.
	mvAutoFeatureControl (mv.impact.acquire.Device device, System.String settingName)
	Constructs a new mv.impact.acquire.GenICam.mvAutoFeatureControl object.
void	restoreDefault ()
	Restores the default for every component of this collection.

Public Attributes
readonly mv.impact.acquire.PropertyI64	mvAutoFeatureAOIHeight = new mv.impact.acquire.PropertyI64()
	An integer property. Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
readonly mv.impact.acquire.PropertyI64	mvAutoFeatureAOIHighlightEnable = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Highlight auto control AOI to check AOI settings. Switch off for normal operation.
readonly mv.impact.acquire.PropertyI64	mvAutoFeatureAOIMode = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.
readonly mv.impact.acquire.PropertyI64	mvAutoFeatureAOIOffsetX = new mv.impact.acquire.PropertyI64()
	An integer property. Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
readonly mv.impact.acquire.PropertyI64	mvAutoFeatureAOIOffsetY = new mv.impact.acquire.PropertyI64()
	An integer property. Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
readonly mv.impact.acquire.PropertyI64	mvAutoFeatureAOIWidth = new mv.impact.acquire.PropertyI64()
	An integer property. Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).
readonly mv.impact.acquire.PropertyI64	mvAutoFeatureBrightness = new mv.impact.acquire.PropertyI64()
	An integer property. Common desired average brightness value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC). At least one of these controllers must be activated for the value to take effect.
readonly mv.impact.acquire.PropertyI64	mvAutoFeatureBrightnessCalculation = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Selects the method to determine the brightness for Auto Exposure Control(AEC) and Auto Gain Control(AGC) controller.
readonly mv.impact.acquire.PropertyI64	mvAutoFeatureBrightnessTolerance = new mv.impact.acquire.PropertyI64()
	An integer property. The error input hysteresis width of the controller. If the brightness error exceeds the half of the value in positive or negative direction, the controller restarts to control the brightness. This property applies to AEC and AGC as well.
readonly mv.impact.acquire.PropertyI64	mvAutoFeatureCharacteristic = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Selects the prioritization between Auto Exposure Control(AEC) and Auto Gain Control(AGC) controller. Both controllers have to be activated before.
readonly mv.impact.acquire.PropertyI64	mvAutoFeatureSensitivity = new mv.impact.acquire.PropertyI64()
	An integer property. The controllers sensitivity of brightness deviations. This parameter influences the gain as well as the exposure controller. At least one of these controllers must be activated for the value to take effect.

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

Contains features to control the image controllers. The properties are applied to Auto Gain Control(AGC) and Auto Exposure Control(AEC) controller. To take effect at least AEC or AGC must be enabled.

Contains features to control the image controllers. The properties are applied to Auto Gain Control(AGC) and Auto Exposure Control(AEC) controller. To take effect at least AEC or AGC must be enabled.

Constructor & Destructor Documentation

mvAutoFeatureControl() [1/2]

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

inline

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

Parameters

[in]

device

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

mvAutoFeatureControl() [2/2]

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

inline

Constructs a new mv.impact.acquire.GenICam.mvAutoFeatureControl 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

mvAutoFeatureAOIHeight

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

An integer property. Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).

Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).

mvAutoFeatureAOIHighlightEnable

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

An enumerated integer property. Highlight auto control AOI to check AOI settings. Switch off for normal operation.

Highlight auto control AOI to check AOI settings. Switch off for normal operation.

The following string values might be valid for this feature:

• Off (Display string: 'Off'): The AutoFeatureAOIHighlight is switched off.
• On (Display string: 'On'): The AutoFeatureAOIHighlight is switched on.

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.

mvAutoFeatureAOIMode

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

An enumerated integer property. Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.

Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing.

The following string values might be valid for this feature:

• mvFull (Display string: 'mv Full'): The auto controller uses the full frame for the actual value computation.
• mvCenter (Display string: 'mv Center'): The auto controller uses a centered AOI of 25% the full frame for the actual value computation.
• mvUser (Display string: 'mv User'): The auto controller uses the user defined AOI for the actual value computation.

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.

mvAutoFeatureAOIOffsetX

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

An integer property. Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).

Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).

mvAutoFeatureAOIOffsetY

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

An integer property. Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).

Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).

mvAutoFeatureAOIWidth

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

An integer property. Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).

Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).

mvAutoFeatureBrightness

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

An integer property. Common desired average brightness value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC). At least one of these controllers must be activated for the value to take effect.

Common desired average brightness value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC). At least one of these controllers must be activated for the value to take effect.

mvAutoFeatureBrightnessCalculation

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

An enumerated integer property. Selects the method to determine the brightness for Auto Exposure Control(AEC) and Auto Gain Control(AGC) controller.

Selects the method to determine the brightness for Auto Exposure Control(AEC) and Auto Gain Control(AGC) controller.

The following string values might be valid for this feature:

• mvPeak (Display string: 'mv Peak'): The peak brightness value is used as actual value for the controller.
• mvAverage (Display string: 'mv Average'): The average brightness is used as actual value for the controller.

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.

mvAutoFeatureBrightnessTolerance

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

An integer property. The error input hysteresis width of the controller. If the brightness error exceeds the half of the value in positive or negative direction, the controller restarts to control the brightness. This property applies to AEC and AGC as well.

The error input hysteresis gap of the controller. If the brightness error exceeds the half of the value in positive or negative direction, the controller restarts to control the brightness. This property applies to AEC and AGC as well.

mvAutoFeatureCharacteristic

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

An enumerated integer property. Selects the prioritization between Auto Exposure Control(AEC) and Auto Gain Control(AGC) controller. Both controllers have to be activated before.

Selects the prioritization between Auto Exposure Control(AEC) and Auto Gain Control(AGC) controller. Both controllers have to be activated before.

The following string values might be valid for this feature:

• mvLowGain (Display string: 'mv Low Gain')
• mvShortExposure (Display string: 'mv Short Exposure')

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.

mvAutoFeatureSensitivity

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

An integer property. The controllers sensitivity of brightness deviations. This parameter influences the gain as well as the exposure controller. At least one of these controllers must be activated for the value to take effect.

The controllers sensitivity of brightness deviations. This parameter influences the gain as well as the exposure controller. At least one of these controllers must be activated for the value to take effect.

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.