mvAutoFeatureControl Class Reference

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

Inheritance diagram for mvAutoFeatureControl:

Public Member Functions
synchronized void	delete ()
PropertyI64	getMvAutoFeatureAOIHeight ()
	An integer property.
PropertyI64	getMvAutoFeatureAOIHighlightEnable ()
	An enumerated integer property.
PropertyI64	getMvAutoFeatureAOIMode ()
	An enumerated integer property.
PropertyI64	getMvAutoFeatureAOIOffsetX ()
	An integer property.
PropertyI64	getMvAutoFeatureAOIOffsetY ()
	An integer property.
PropertyI64	getMvAutoFeatureAOIWidth ()
	An integer property.
PropertyI64	getMvAutoFeatureBrightness ()
	An integer property.
PropertyI64	getMvAutoFeatureBrightnessCalculation ()
	An enumerated integer property.
PropertyI64	getMvAutoFeatureBrightnessTolerance ()
	An integer property.
PropertyI64	getMvAutoFeatureCharacteristic ()
	An enumerated integer property.
PropertyI64	getMvAutoFeatureSensitivity ()
	An integer property.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
	mvAutoFeatureControl (Device pDev)
	Constructs a new mvIMPACT.acquire.mvAutoFeatureControl object.
	mvAutoFeatureControl (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.mvAutoFeatureControl object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

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

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

Protected Attributes
transient boolean	swigCMemOwn

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

mvAutoFeatureControl ( long cPtr, boolean cMemoryOwn )

protected

mvAutoFeatureControl() [2/3]

mvAutoFeatureControl	(	Device	pDev,
		String	settingName )

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

mvAutoFeatureControl() [3/3]

mvAutoFeatureControl

(

Device

pDev

)

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

getMvAutoFeatureAOIHeight()

PropertyI64 getMvAutoFeatureAOIHeight

(

)

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

getMvAutoFeatureAOIHighlightEnable()

PropertyI64 getMvAutoFeatureAOIHighlightEnable

(

)

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.

getMvAutoFeatureAOIMode()

PropertyI64 getMvAutoFeatureAOIMode

(

)

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.

getMvAutoFeatureAOIOffsetX()

PropertyI64 getMvAutoFeatureAOIOffsetX

(

)

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

getMvAutoFeatureAOIOffsetY()

PropertyI64 getMvAutoFeatureAOIOffsetY

(

)

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

getMvAutoFeatureAOIWidth()

PropertyI64 getMvAutoFeatureAOIWidth

(

)

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

getMvAutoFeatureBrightness()

PropertyI64 getMvAutoFeatureBrightness

(

)

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.

getMvAutoFeatureBrightnessCalculation()

PropertyI64 getMvAutoFeatureBrightnessCalculation

(

)

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.

getMvAutoFeatureBrightnessTolerance()

PropertyI64 getMvAutoFeatureBrightnessTolerance

(

)

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.

getMvAutoFeatureCharacteristic()

PropertyI64 getMvAutoFeatureCharacteristic

(

)

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.

getMvAutoFeatureSensitivity()

PropertyI64 getMvAutoFeatureSensitivity

(

)

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.

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

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited