mvIMPACT Acquire SDK C++
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:
ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
 mvAutoFeatureControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::mvAutoFeatureControl object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyI64 mvAutoFeatureAOIHeight
 An integer property. Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB). More...
 
PropertyI64 mvAutoFeatureAOIHighlightEnable
 An enumerated integer property. Highlight auto control AOI to check AOI settings. Switch off for normal operation. More...
 
PropertyI64 mvAutoFeatureAOIMode
 An enumerated integer property. Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing. More...
 
PropertyI64 mvAutoFeatureAOIOffsetX
 An integer property. Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB). More...
 
PropertyI64 mvAutoFeatureAOIOffsetY
 An integer property. Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB). More...
 
PropertyI64 mvAutoFeatureAOIWidth
 An integer property. Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB). More...
 
PropertyI64 mvAutoFeatureBrightness
 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. More...
 
PropertyI64 mvAutoFeatureBrightnessCalculation
 An enumerated integer property. Selects the method to determine the brightness for Auto Exposure Control(AEC) and Auto Gain Control(AGC) controller. More...
 
PropertyI64 mvAutoFeatureBrightnessTolerance
 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. More...
 
PropertyI64 mvAutoFeatureCharacteristic
 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. More...
 
PropertyI64 mvAutoFeatureSensitivity
 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. More...
 

Protected Attributes

HOBJ m_hRoot
 

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

mvAutoFeatureControl ( mvIMPACT::acquire::Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::GenICam::mvAutoFeatureControl object.

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]settingNameThe 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

Member Function Documentation

◆ hObj()

HOBJ hObj ( void  ) const
inlineinherited

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

const ComponentCollection& restoreDefault ( void  ) const
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.
Returns
A const reference to the component.

Member Data Documentation

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ mvAutoFeatureAOIHeight

PropertyI64 mvAutoFeatureAOIHeight

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

PropertyI64 mvAutoFeatureAOIHighlightEnable

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

◆ mvAutoFeatureAOIMode

PropertyI64 mvAutoFeatureAOIMode

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

◆ mvAutoFeatureAOIOffsetX

PropertyI64 mvAutoFeatureAOIOffsetX

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

PropertyI64 mvAutoFeatureAOIOffsetY

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

PropertyI64 mvAutoFeatureAOIWidth

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

PropertyI64 mvAutoFeatureBrightness

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

PropertyI64 mvAutoFeatureBrightnessCalculation

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

◆ mvAutoFeatureBrightnessTolerance

PropertyI64 mvAutoFeatureBrightnessTolerance

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

PropertyI64 mvAutoFeatureCharacteristic

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

◆ mvAutoFeatureSensitivity

PropertyI64 mvAutoFeatureSensitivity

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.


The documentation for this class was generated from the following file: