mvAutoFeatureControl Class Reference

Contains features to control the image controllers. More...

Inheritance diagram for mvAutoFeatureControl:

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

Properties
	mvAutoFeatureAOIHeight = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureAOIHeight_get, doc=)
	An integer property.
	mvAutoFeatureAOIHighlightEnable = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureAOIHighlightEnable_get, doc=)
	An enumerated integer property.
	mvAutoFeatureAOIMode = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureAOIMode_get, doc=)
	An enumerated integer property.
	mvAutoFeatureAOIOffsetX = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureAOIOffsetX_get, doc=)
	An integer property.
	mvAutoFeatureAOIOffsetY = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureAOIOffsetY_get, doc=)
	An integer property.
	mvAutoFeatureAOIWidth = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureAOIWidth_get, doc=)
	An integer property.
	mvAutoFeatureBrightness = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureBrightness_get, doc=)
	An integer property.
	mvAutoFeatureBrightnessCalculation = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureBrightnessCalculation_get, doc=)
	An enumerated integer property.
	mvAutoFeatureBrightnessTolerance = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureBrightnessTolerance_get, doc=)
	An integer property.
	mvAutoFeatureCharacteristic = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureCharacteristic_get, doc=)
	An enumerated integer property.
	mvAutoFeatureSensitivity = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureSensitivity_get, doc=)
	An integer property.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

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

__init__()

__init__	(		self,
		*	args )

Constructs a new mvIMPACT.acquire.mvAutoFeatureControl 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

mvAutoFeatureAOIHeight

mvAutoFeatureAOIHeight = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureAOIHeight_get, doc=)

static

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

mvAutoFeatureAOIHighlightEnable = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureAOIHighlightEnable_get, doc=)

static

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

mvAutoFeatureAOIMode

mvAutoFeatureAOIMode = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureAOIMode_get, doc=)

static

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

mvAutoFeatureAOIOffsetX

mvAutoFeatureAOIOffsetX = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureAOIOffsetX_get, doc=)

static

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

mvAutoFeatureAOIOffsetY = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureAOIOffsetY_get, doc=)

static

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

mvAutoFeatureAOIWidth = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureAOIWidth_get, doc=)

static

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

mvAutoFeatureBrightness = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureBrightness_get, doc=)

static

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

mvAutoFeatureBrightnessCalculation = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureBrightnessCalculation_get, doc=)

static

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

mvAutoFeatureBrightnessTolerance

mvAutoFeatureBrightnessTolerance = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureBrightnessTolerance_get, doc=)

static

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

mvAutoFeatureCharacteristic = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureCharacteristic_get, doc=)

static

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

mvAutoFeatureSensitivity

mvAutoFeatureSensitivity = property(lib_mvIMPACT_acquire.mvAutoFeatureControl_mvAutoFeatureSensitivity_get, doc=)

static

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.

thisown

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

static