mvIMPACT Acquire SDK C++

Category that contains the Analog control features. More...

Public Member Functions

 AnalogControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::AnalogControl object. More...
 

Public Attributes

PropertyF balanceRatio
 A floating point property. Controls ratio of the selected color component to a reference color component. More...
 
PropertyI64 balanceRatioSelector
 An enumerated integer property. Selects which Balance ratio to control. More...
 
PropertyI64 balanceWhiteAuto
 An enumerated integer property. Controls the mode for automatic white balancing between the color channels. More...
 
PropertyF blackLevel
 A floating point property. Controls the analog black level as an absolute physical value. More...
 
PropertyI64 blackLevelAuto
 An enumerated integer property. Controls the mode for automatic black level adjustment. More...
 
PropertyI64 blackLevelAutoBalance
 An enumerated integer property. Controls the mode for automatic black level balancing between the sensor color channels or taps. More...
 
PropertyI64 blackLevelSelector
 An enumerated integer property. Selects which Black Level is controlled by the various Black Level features. More...
 
PropertyF gain
 A floating point property. Controls the selected gain as an absolute physical value. More...
 
PropertyI64 gainAuto
 An enumerated integer property. Sets the automatic gain control (AGC) mode. More...
 
PropertyI64 gainAutoBalance
 An enumerated integer property. Sets the mode for automatic gain balancing between the sensor color channels or taps. More...
 
PropertyI64 gainSelector
 An enumerated integer property. Selects which Gain is controlled by the various Gain features. More...
 
PropertyF gamma
 A floating point property. Controls the gamma correction of pixel intensity. More...
 
PropertyI64 mvADCGain
 An integer property. Adapt gain. Gain value of the sensor may differ from sensor to sensor. More...
 
PropertyI64 mvBalanceWhiteAutoAOIMode
 An enumerated integer property. Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB). More...
 
PropertyI64 mvBalanceWhiteAutoHeight
 An integer property. Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB). More...
 
PropertyI64 mvBalanceWhiteAutoOffsetX
 An integer property. Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB). More...
 
PropertyI64 mvBalanceWhiteAutoOffsetY
 An integer property. Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB). More...
 
PropertyI64 mvBalanceWhiteAutoWidth
 An integer property. Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB). More...
 
PropertyI64 mvDigitalGainOffset
 An integer property. Used for fine tuning of the brightness of the sensor. More...
 
PropertyI64 mvGainAutoAOIMode
 An enumerated integer property. Common AutoControl AOI used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balancing. More...
 
PropertyI64 mvGainAutoAverageGrey
 An integer property. Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC). More...
 
PropertyI64 mvGainAutoDelayImages
 An integer property. The number of frames that the AEC must skip before updating the exposure register. More...
 
PropertyI64 mvGainAutoHeight
 An integer property. Common AOI Height used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB). More...
 
PropertyI64 mvGainAutoHighlightAOI
 An enumerated integer property. Highlight auto control AOI to check AOI settings. Switch off for normal operation. More...
 
PropertyF mvGainAutoLowerLimit
 A floating point property. The lower limit of the gain in auto gain mode. More...
 
PropertyI64 mvGainAutoMode
 An enumerated integer property. Selects the common auto mode for gain and exposure. More...
 
PropertyI64 mvGainAutoOffsetX
 An integer property. Common AOI X-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB). More...
 
PropertyI64 mvGainAutoOffsetY
 An integer property. Common AOI Y-Offset used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB). More...
 
PropertyI64 mvGainAutoSpeed
 An enumerated integer property. Determines the increment or decrement size of gain value from frame to frame. More...
 
PropertyF mvGainAutoUpperLimit
 A floating point property. The upper limit of the gain in auto gain mode. More...
 
PropertyI64 mvGainAutoWidth
 An integer property. Common AOI Width used for Auto Gain Control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB). More...
 
PropertyF mvGainHorizontalZoneDivider
 A floating point property. Defines the position(in percent of the total number of lines) within the image to switch from one gain value to the next. More...
 
PropertyI64 mvGainMode
 An enumerated integer property. Sets the operation mode of Gain. More...
 
PropertyIBoolean mvGammaEnable
 A boolean property. Enables Gamma correction. All other LUT will be disabled. More...
 
PropertyI64 mvGammaSelector
 An enumerated integer property. Sets the type of Gamma to be used. More...
 
PropertyI64 mvLinearLogarithmicMode
 An integer property. Controls the knee point between linear response and logarithmic response. More...
 
PropertyI64 mvLowLight
 An enumerated integer property. Makes the image brighter. More...
 
Method mvSaveCalibrationData
 A method object. Saves the calibration data to non-volatile memory. More...
 
PropertyI64 mvTapBalancingMode
 An enumerated integer property. Where do the tap balancing calibration data come from? More...
 
PropertyI64 mvVRamp
 An integer property. Adjusting this value will result in better column CDS (correlated double sampling) which will remove the column FPN from the image. More...
 
PropertyF whiteClip
 A floating point property. Controls the maximal intensity taken by the video signal before being clipped as an absolute physical value. More...
 
PropertyI64 whiteClipSelector
 An enumerated integer property. Selects which White Clip to control. More...
 

Detailed Description

Category that contains the Analog control features.

A category that contains the Analog control features.

Examples
GenICamCommonSettingsUsage.cpp, and GenICamCommonSettingsUsage.legacy.cpp.

Constructor & Destructor Documentation

◆ AnalogControl()

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

Constructs a new mvIMPACT::acquire::GenICam::AnalogControl 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 Data Documentation

◆ balanceRatio

PropertyF balanceRatio

A floating point property. Controls ratio of the selected color component to a reference color component.

Controls ratio of the selected color component to a reference color component. It is used for white balancing.

◆ balanceRatioSelector

PropertyI64 balanceRatioSelector

An enumerated integer property. Selects which Balance ratio to control.

Selects which Balance ratio to control.

The following string values might be valid for this feature:

  • All (Display string: 'All'): Balance Ratio will be applied to all channels or taps.
  • Red (Display string: 'Red'): Balance Ratio will be applied to the red channel.
  • Green (Display string: 'Green'): Balance Ratio will be applied to the green channel.
  • Blue (Display string: 'Blue'): Balance Ratio will be applied to the blue channel.
  • Y (Display string: 'Y'): Balance Ratio will be applied to Y channel.
  • U (Display string: 'U'): Balance Ratio will be applied to U channel.
  • V (Display string: 'V'): Balance Ratio will be applied to V channel.
  • Tap1 (Display string: 'Tap 1'): Balance Ratio will be applied to Tap 1.
  • Tap2 (Display string: 'Tap 2'): Balance Ratio will be applied to Tap 2.
  • Tap#3# (Display string: 'Tap #3#'): Balance Ratio will be applied to Tap #3#.
  • Green0 (Display string: 'Green 0')
  • Green1 (Display string: 'Green 1')
  • Tap3 (Display string: 'Tap 3'): Balance Ratio will be applied to Tap 3.
  • Tap4 (Display string: 'Tap 4'): Balance Ratio will be applied to Tap 4.
  • Tap5 (Display string: 'Tap 5'): Balance Ratio will be applied to Tap 5.
  • Tap6 (Display string: 'Tap 6'): Balance Ratio will be applied to Tap 6.
  • Tap7 (Display string: 'Tap 7'): Balance Ratio will be applied to Tap 7.
  • Tap8 (Display string: 'Tap 8'): Balance Ratio will be applied to Tap 8.
  • Tap9 (Display string: 'Tap 9'): Balance Ratio will be applied to Tap 9.
  • Tap10 (Display string: 'Tap 10'): Balance Ratio will be applied to Tap 10.
  • Tap11 (Display string: 'Tap 11'): Balance Ratio will be applied to Tap 11.
  • Tap12 (Display string: 'Tap 12'): Balance Ratio will be applied to Tap 12.
  • Tap13 (Display string: 'Tap 13'): Balance Ratio will be applied to Tap 13.
  • Tap14 (Display string: 'Tap 14'): Balance Ratio will be applied to Tap 14.
  • Tap15 (Display string: 'Tap 15'): Balance Ratio will be applied to Tap 15.
  • Tap16 (Display string: 'Tap 16')
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.

◆ balanceWhiteAuto

PropertyI64 balanceWhiteAuto

An enumerated integer property. Controls the mode for automatic white balancing between the color channels.

Controls the mode for automatic white balancing between the color channels. The white balancing ratios are automatically adjusted.

The following string values might be valid for this feature:

  • Off (Display string: 'Off'): White balancing is user controlled using BalanceRatioSelector and BalanceRatio.
  • Once (Display string: 'Once'): White balancing is automatically adjusted once by the device. Once it has converged, it automatically returns to the Off state.
  • Continuous (Display string: 'Continuous'): White balancing is constantly adjusted by the device.
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.

◆ blackLevel

PropertyF blackLevel

A floating point property. Controls the analog black level as an absolute physical value.

Controls the analog black level as an absolute physical value. This represents a DC offset applied to the video signal.

◆ blackLevelAuto

PropertyI64 blackLevelAuto

An enumerated integer property. Controls the mode for automatic black level adjustment.

Controls the mode for automatic black level adjustment. The exact algorithm used to implement this adjustment is device-specific.

The following string values might be valid for this feature:

  • Off (Display string: 'Off'): Analog black level is user controlled using BlackLevel.
  • Once (Display string: 'Once'): Analog black level is automatically adjusted once by the device. Once it has converged, it automatically returns to the Off state.
  • Continuous (Display string: 'Continuous'): Analog black level is constantly adjusted by the device.
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.

◆ blackLevelAutoBalance

PropertyI64 blackLevelAutoBalance

An enumerated integer property. Controls the mode for automatic black level balancing between the sensor color channels or taps.

Controls the mode for automatic black level balancing between the sensor color channels or taps. The black level coefficients of each channel are adjusted so they are matched.

The following string values might be valid for this feature:

  • Off (Display string: 'Off'): Black level tap balancing is user controlled using BlackLevel.
  • Once (Display string: 'Once'): Black level tap balancing is automatically adjusted once by the device. Once it has converged, it automatically returns to the Off state.
  • Continuous (Display string: 'Continuous'): Black level tap balancing is constantly adjusted by the device.
  • mvRaw (Display string: 'mv Raw')
  • mvFixed (Display string: 'mv Fixed')
  • mvLowerLine (Display string: 'mv Lower Line')
  • mvSlow (Display string: 'mv Slow')
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.

◆ blackLevelSelector

PropertyI64 blackLevelSelector

An enumerated integer property. Selects which Black Level is controlled by the various Black Level features.

Selects which Black Level is controlled by the various Black Level features.

The following string values might be valid for this feature:

  • All (Display string: 'All'): Black Level will be applied to all channels or taps.
  • Red (Display string: 'Red'): Black Level will be applied to the red channel.
  • Green (Display string: 'Green'): Black Level will be applied to the green channel.
  • Blue (Display string: 'Blue'): Black Level will be applied to the blue channel.
  • Y (Display string: 'Y'): Black Level will be applied to Y channel.
  • U (Display string: 'U'): Black Level will be applied to U channel.
  • V (Display string: 'V'): Black Level will be applied to V channel.
  • Tap1 (Display string: 'Tap 1'): Black Level will be applied to Tap 1.
  • Tap2 (Display string: 'Tap 2'): Black Level will be applied to Tap 2.
  • Tap#3# (Display string: 'Tap #3#'): Black Level will be applied to Tap #3#.
  • Tap3 (Display string: 'Tap 3'): Black Level will be applied to Tap 3.
  • Tap4 (Display string: 'Tap 4'): Black Level will be applied to Tap 4.
  • Tap5 (Display string: 'Tap 5'): Black Level will be applied to Tap 5.
  • Tap6 (Display string: 'Tap 6'): Black Level will be applied to Tap 6.
  • Tap7 (Display string: 'Tap 7'): Black Level will be applied to Tap 7.
  • Tap8 (Display string: 'Tap 8'): Black Level will be applied to Tap 8.
  • Tap9 (Display string: 'Tap 9'): Black Level will be applied to Tap 9.
  • Tap10 (Display string: 'Tap 10'): Black Level will be applied to Tap 10.
  • Tap11 (Display string: 'Tap 11'): Black Level will be applied to Tap 11.
  • Tap12 (Display string: 'Tap 12'): Black Level will be applied to Tap 12.
  • Tap13 (Display string: 'Tap 13'): Black Level will be applied to Tap 13.
  • Tap14 (Display string: 'Tap 14'): Black Level will be applied to Tap 14.
  • Tap15 (Display string: 'Tap 15'): Black Level will be applied to Tap 15.
  • Tap16 (Display string: 'Tap 16')
  • mvAnalogSensorA (Display string: 'mv Analog Sensor A')
  • mvAnalogSensorB (Display string: 'mv Analog Sensor B')
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.

◆ gain

PropertyF gain

A floating point property. Controls the selected gain as an absolute physical value.

Controls the selected gain as an absolute physical value. This is an amplification factor applied to the video signal.

◆ gainAuto

PropertyI64 gainAuto

An enumerated integer property. Sets the automatic gain control (AGC) mode.

Sets the automatic gain control (AGC) mode. The exact algorithm used to implement AGC is device-specific.

The following string values might be valid for this feature:

  • Off (Display string: 'Off'): Gain is User controlled using Gain.
  • Once (Display string: 'Once'): Gain is automatically adjusted once by the device. Once it has converged, it automatically returns to the Off state.
  • Continuous (Display string: 'Continuous'): Gain is constantly adjusted by the device.
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.

◆ gainAutoBalance

PropertyI64 gainAutoBalance

An enumerated integer property. Sets the mode for automatic gain balancing between the sensor color channels or taps.

Sets the mode for automatic gain balancing between the sensor color channels or taps. The gain coefficients of each channel or tap are adjusted so they are matched.

The following string values might be valid for this feature:

  • Off (Display string: 'Off'): Gain tap balancing is user controlled using Gain .
  • Once (Display string: 'Once'): Gain tap balancing is automatically adjusted once by the device. Once it has converged, it automatically returns to the Off state.
  • Continuous (Display string: 'Continuous'): Gain tap balancing is constantly adjusted by the device.
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.

◆ gainSelector

PropertyI64 gainSelector

An enumerated integer property. Selects which Gain is controlled by the various Gain features.

Selects which Gain is controlled by the various Gain features.

The following string values might be valid for this feature:

  • All (Display string: 'All'): Gain will be applied to all channels or taps.
  • Red (Display string: 'Red'): Gain will be applied to the red channel.
  • Green (Display string: 'Green'): Gain will be applied to the green channel.
  • Blue (Display string: 'Blue'): Gain will be applied to the blue channel.
  • Y (Display string: 'Y'): Gain will be applied to Y channel.
  • U (Display string: 'U'): Gain will be applied to U channel.
  • V (Display string: 'V'): Gain will be applied to V channel.
  • Tap1 (Display string: 'Tap 1'): Gain will be applied to Tap 1.
  • Tap2 (Display string: 'Tap 2'): Gain will be applied to Tap 2.
  • Tap#3# (Display string: 'Tap #3#'): Gain will be applied to Tap #3#.
  • AnalogAll (Display string: 'Analog All'): Gain will be applied to all analog channels or taps.
  • AnalogRed (Display string: 'Analog Red'): Gain will be applied to the red analog channel.
  • AnalogGreen (Display string: 'Analog Green'): Gain will be applied to the green analog channel.
  • AnalogBlue (Display string: 'Analog Blue'): Gain will be applied to the blue analog channel.
  • AnalogY (Display string: 'Analog Y'): Gain will be applied to Y analog channel.
  • AnalogU (Display string: 'Analog U'): Gain will be applied to U analog channel.
  • AnalogV (Display string: 'Analog V'): Gain will be applied to V analog channel.
  • AnalogTap1 (Display string: 'Analog Tap 1'): Analog gain will be applied to Tap 1.
  • AnalogTap2 (Display string: 'Analog Tap 2'): Analog gain will be applied to Tap 2.
  • AnalogTap#3# (Display string: 'Analog Tap #3#'): Analog gain will be applied to Tap #3#.
  • DigitalAll (Display string: 'Digital All'): Gain will be applied to all digital channels or taps.
  • DigitalRed (Display string: 'Digital Red'): Gain will be applied to the red digital channel.
  • DigitalGreen (Display string: 'Digital Green'): Gain will be applied to the green digital channel.
  • DigitalBlue (Display string: 'Digital Blue'): Gain will be applied to the blue digital channel.
  • DigitalY (Display string: 'Digital Y'): Gain will be applied to Y digital channel.
  • DigitalU (Display string: 'Digital U'): Gain will be applied to U digital channel.
  • DigitalV (Display string: 'Digital V'): Gain will be applied to V digital channel.
  • DigitalTap1 (Display string: 'Digital Tap 1'): Digital gain will be applied to Tap 1.
  • DigitalTap2 (Display string: 'Digital Tap 2'): Digital gain will be applied to Tap 2.
  • DigitalTap#3# (Display string: 'Digital Tap #3#'): Digital gain will be applied to Tap #3#.
  • Tap3 (Display string: 'Tap 3'): Gain will be applied to Tap 3.
  • Tap4 (Display string: 'Tap 4'): Gain will be applied to Tap 4.
  • Tap5 (Display string: 'Tap 5'): Gain will be applied to Tap 5.
  • Tap6 (Display string: 'Tap 6'): Gain will be applied to Tap 6.
  • Tap7 (Display string: 'Tap 7'): Gain will be applied to Tap 7.
  • Tap8 (Display string: 'Tap 8'): Gain will be applied to Tap 8.
  • Tap9 (Display string: 'Tap 9'): Gain will be applied to Tap 9.
  • Tap10 (Display string: 'Tap 10'): Gain will be applied to Tap 10.
  • Tap11 (Display string: 'Tap 11'): Gain will be applied to Tap 11.
  • Tap12 (Display string: 'Tap 12'): Gain will be applied to Tap 12.
  • Tap13 (Display string: 'Tap 13'): Gain will be applied to Tap 13.
  • Tap14 (Display string: 'Tap 14'): Gain will be applied to Tap 14.
  • Tap15 (Display string: 'Tap 15'): Gain will be applied to Tap 15.
  • Tap16 (Display string: 'Tap 16')
  • AnalogTap3 (Display string: 'Analog Tap 3'): Analog gain will be applied to Tap 3.
  • AnalogTap4 (Display string: 'Analog Tap 4'): Analog gain will be applied to Tap 4.
  • AnalogTap5 (Display string: 'Analog Tap 5'): Analog gain will be applied to Tap 5.
  • AnalogTap6 (Display string: 'Analog Tap 6'): Analog gain will be applied to Tap 6.
  • AnalogTap7 (Display string: 'Analog Tap 7'): Analog gain will be applied to Tap 7.
  • AnalogTap8 (Display string: 'Analog Tap 8'): Analog gain will be applied to Tap 8.
  • AnalogTap9 (Display string: 'Analog Tap 9'): Analog gain will be applied to Tap 9.
  • AnalogTap10 (Display string: 'Analog Tap 10'): Analog gain will be applied to Tap 10.
  • AnalogTap11 (Display string: 'Analog Tap 11'): Analog gain will be applied to Tap 11.
  • AnalogTap12 (Display string: 'Analog Tap 12'): Analog gain will be applied to Tap 12.
  • AnalogTap13 (Display string: 'Analog Tap 13'): Analog gain will be applied to Tap 13.
  • AnalogTap14 (Display string: 'Analog Tap 14'): Analog gain will be applied to Tap 14.
  • AnalogTap15 (Display string: 'Analog Tap 15'): Analog gain will be applied to Tap 15.
  • AnalogTap16 (Display string: 'Analog Tap 16')
  • DigitalTap3 (Display string: 'Digital Tap 3'): Digital gain will be applied to Tap 3.
  • DigitalTap4 (Display string: 'Digital Tap 4'): Digital gain will be applied to Tap 4.
  • DigitalTap5 (Display string: 'Digital Tap 5'): Digital gain will be applied to Tap 5.
  • DigitalTap6 (Display string: 'Digital Tap 6'): Digital gain will be applied to Tap 6.
  • DigitalTap7 (Display string: 'Digital Tap 7'): Digital gain will be applied to Tap 7.
  • DigitalTap8 (Display string: 'Digital Tap 8'): Digital gain will be applied to Tap 8.
  • DigitalTap9 (Display string: 'Digital Tap 9'): Digital gain will be applied to Tap 9.
  • DigitalTap10 (Display string: 'Digital Tap 10'): Digital gain will be applied to Tap 10.
  • DigitalTap11 (Display string: 'Digital Tap 11'): Digital gain will be applied to Tap 11.
  • DigitalTap12 (Display string: 'Digital Tap 12'): Digital gain will be applied to Tap 12.
  • DigitalTap13 (Display string: 'Digital Tap 13'): Digital gain will be applied to Tap 13.
  • DigitalTap14 (Display string: 'Digital Tap 14'): Digital gain will be applied to Tap 14.
  • DigitalTap15 (Display string: 'Digital Tap 15'): Digital gain will be applied to Tap 15.
  • DigitalTap16 (Display string: 'Digital Tap 16')
  • mvAnalogSensorA (Display string: 'mv Analog Sensor A')
  • mvAnalogSensorB (Display string: 'mv Analog Sensor B')
  • mvHorizontalZone0 (Display string: 'mv Horizontal Zone 0'): Selects the first horizontal gain zone used when 'mvGainMode' is set to 'mvMultiZone' and when operating the device in a 'mvMultiAreaMode' different from 'mvOff'.
  • mvHorizontalZone1 (Display string: 'mv Horizontal Zone 1'): Selects the second horizontal gain zone used when 'mvGainMode' is set to 'mvMultiZone' and when operating the device in a 'mvMultiAreaMode' different from 'mvOff'.
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.

◆ gamma

PropertyF gamma

A floating point property. Controls the gamma correction of pixel intensity.

Controls the gamma correction of pixel intensity. Since the human eye perceives light similar to a logarithm of real light intensity it's characteristic curve is non-linear. It follows the rule of (intensity ^ gamma) with a gamma value between 0.3-0.5. To provide as much useful information as possible, the image is converted from 12-bit acquired by the sensor to 8-bit utilizing this characteristic curve. The result is a linearized image optimized for the human eye's non-linear behavior which allows to perceive as much intensity differences as possible.

Conversion from 12- to 8-bit utilizing the gamma function

◆ mvADCGain

PropertyI64 mvADCGain

An integer property. Adapt gain. Gain value of the sensor may differ from sensor to sensor.

Adapt gain. Gain value of the sensor may differ from sensor to sensor.

◆ mvBalanceWhiteAutoAOIMode

PropertyI64 mvBalanceWhiteAutoAOIMode

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

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

The following string values might be valid for this feature:

  • mvFull (Display string: 'mv Full')
  • mvCenter (Display string: 'mv Center')
  • mvUser (Display string: 'mv User')
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.

◆ mvBalanceWhiteAutoHeight

PropertyI64 mvBalanceWhiteAutoHeight

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

◆ mvBalanceWhiteAutoOffsetX

PropertyI64 mvBalanceWhiteAutoOffsetX

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

Common AOI XOffset used for auto gain control(AGC), Auto Exposure Control(AEC) and Auto White Balance(AWB).

◆ mvBalanceWhiteAutoOffsetY

PropertyI64 mvBalanceWhiteAutoOffsetY

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

◆ mvBalanceWhiteAutoWidth

PropertyI64 mvBalanceWhiteAutoWidth

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

◆ mvDigitalGainOffset

PropertyI64 mvDigitalGainOffset

An integer property. Used for fine tuning of the brightness of the sensor.

Used for fine tuning of the brightness of the sensor.

◆ mvGainAutoAOIMode

PropertyI64 mvGainAutoAOIMode

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')
  • mvCenter (Display string: 'mv Center')
  • mvUser (Display string: 'mv User')
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.

◆ mvGainAutoAverageGrey

PropertyI64 mvGainAutoAverageGrey

An integer property. Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).

Common desired average grey value (in percent) used for Auto Gain Control(AGC) and Auto Exposure Control(AEC).

◆ mvGainAutoDelayImages

PropertyI64 mvGainAutoDelayImages

An integer property. The number of frames that the AEC must skip before updating the exposure register.

The number of frames that the AEC must skip before updating the exposure register

◆ mvGainAutoHeight

PropertyI64 mvGainAutoHeight

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

◆ mvGainAutoHighlightAOI

PropertyI64 mvGainAutoHighlightAOI

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')
  • On (Display string: '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.

◆ mvGainAutoLowerLimit

PropertyF mvGainAutoLowerLimit

A floating point property. The lower limit of the gain in auto gain mode.

The lower limit of the gain in auto gain mode

◆ mvGainAutoMode

PropertyI64 mvGainAutoMode

An enumerated integer property. Selects the common auto mode for gain and exposure.

Selects the common auto mode for gain and exposure.

The following string values might be valid for this feature:

  • mvSensor (Display string: 'mv Sensor'): The sensor itself will do the auto control.
  • mvDevice (Display string: 'mv Device'): The device(firmware) will do the auto control.
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.

◆ mvGainAutoOffsetX

PropertyI64 mvGainAutoOffsetX

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

◆ mvGainAutoOffsetY

PropertyI64 mvGainAutoOffsetY

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

◆ mvGainAutoSpeed

PropertyI64 mvGainAutoSpeed

An enumerated integer property. Determines the increment or decrement size of gain value from frame to frame.

Determines the increment or decrement size of gain value from frame to frame.

The following string values might be valid for this feature:

  • Slow (Display string: 'Slow')
  • Medium (Display string: 'Medium')
  • Fast (Display string: 'Fast')
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.

◆ mvGainAutoUpperLimit

PropertyF mvGainAutoUpperLimit

A floating point property. The upper limit of the gain in auto gain mode.

The upper limit of the gain in auto gain mode

◆ mvGainAutoWidth

PropertyI64 mvGainAutoWidth

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

◆ mvGainHorizontalZoneDivider

PropertyF mvGainHorizontalZoneDivider

A floating point property. Defines the position(in percent of the total number of lines) within the image to switch from one gain value to the next.

Defines the position(in percent of the total number of lines) within the image to switch from one gain value to the next. 100% means that only one zone exists. 25% means that the upper 25% of the image are defined by the gain value of 'mvHorizontalZone0' and the lower 75% are defined by the gain value of 'mvHorizontalZone1'. Some sensors may only allow to change the gain at certain positions e.g. the last line of a defined ROI. In this case the first possible switching point above the actual line will be used.

◆ mvGainMode

PropertyI64 mvGainMode

An enumerated integer property. Sets the operation mode of Gain.

Sets the operation mode of Gain

The following string values might be valid for this feature:

  • Default (Display string: 'Default'): Default operation mode. The whole image is configured as a single zone.
  • mvMultiZone (Display string: 'mv Multi Zone'): In this mode different gains can be applied to different zones of the image by writing them into the 'mvHorizontalZone' registers selectable via the 'GainSelector'. This mode will only have effect on the image when operating the device in a 'mvMultiAreaMode' different from 'mvOff'.
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.

◆ mvGammaEnable

PropertyIBoolean mvGammaEnable

A boolean property. Enables Gamma correction. All other LUT will be disabled.

Enables gamma correction. All other LUT will be disabled.

◆ mvGammaSelector

PropertyI64 mvGammaSelector

An enumerated integer property. Sets the type of Gamma to be used.

Sets the type of Gamma to be used.

The following string values might be valid for this feature:

  • mvSRGB (Display string: 'mv SRGB'): Gamma curve is fixed to a sRGB curve.
  • mvUser (Display string: 'mv User'): Gamma curve can be configured by user.
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.

◆ mvLinearLogarithmicMode

PropertyI64 mvLinearLogarithmicMode

An integer property. Controls the knee point between linear response and logarithmic response.

Controls the knee point between linear response and logarithmic response.

◆ mvLowLight

PropertyI64 mvLowLight

An enumerated integer property. Makes the image brighter.

Makes the image brighter.

The following string values might be valid for this feature:

  • On (Display string: 'On')
  • Off (Display string: 'Off')
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.

◆ mvSaveCalibrationData

Method mvSaveCalibrationData

A method object. Saves the calibration data to non-volatile memory.

Saves the calibration data to non-volatile memory.

◆ mvTapBalancingMode

PropertyI64 mvTapBalancingMode

An enumerated integer property. Where do the tap balancing calibration data come from?

Where do the tap balancing calibration data come from?

The following string values might be valid for this feature:

  • mvFactory (Display string: 'mv Factory')
  • mvUser (Display string: 'mv User')
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.

◆ mvVRamp

PropertyI64 mvVRamp

An integer property. Adjusting this value will result in better column CDS (correlated double sampling) which will remove the column FPN from the image.

Adjusting this value will result in better column CDS (correlated double sampling) which will remove the column FPN from the image.

◆ whiteClip

PropertyF whiteClip

A floating point property. Controls the maximal intensity taken by the video signal before being clipped as an absolute physical value.

Controls the maximal intensity taken by the video signal before being clipped as an absolute physical value. The video signal will never exceed the white clipping point: it will saturate at that level.

◆ whiteClipSelector

PropertyI64 whiteClipSelector

An enumerated integer property. Selects which White Clip to control.

Selects which White Clip to control.

The following string values might be valid for this feature:

  • All (Display string: 'All'): White Clip will be applied to all channels or taps.
  • Red (Display string: 'Red'): White Clip will be applied to the red channel.
  • Green (Display string: 'Green'): White Clip will be applied to the green channel.
  • Blue (Display string: 'Blue'): White Clip will be applied to the blue channel.
  • Y (Display string: 'Y'): White Clip will be applied to Y channel.
  • U (Display string: 'U'): White Clip will be applied to U channel.
  • V (Display string: 'V'): White Clip will be applied to V channel.
  • Tap1 (Display string: 'Tap 1'): White Clip will be applied to Tap 1.
  • Tap2 (Display string: 'Tap 2'): White Clip will be applied to Tap 2.
  • Tap#3# (Display string: 'Tap #3#'): White Clip will be applied to Tap #3#.
  • Tap3 (Display string: 'Tap 3'): White Clip will be applied to Tap 3.
  • Tap4 (Display string: 'Tap 4'): White Clip will be applied to Tap 4.
  • Tap5 (Display string: 'Tap 5'): White Clip will be applied to Tap 5.
  • Tap6 (Display string: 'Tap 6'): White Clip will be applied to Tap 6.
  • Tap7 (Display string: 'Tap 7'): White Clip will be applied to Tap 7.
  • Tap8 (Display string: 'Tap 8'): White Clip will be applied to Tap 8.
  • Tap9 (Display string: 'Tap 9'): White Clip will be applied to Tap 9.
  • Tap10 (Display string: 'Tap 10'): White Clip will be applied to Tap 10.
  • Tap11 (Display string: 'Tap 11'): White Clip will be applied to Tap 11.
  • Tap12 (Display string: 'Tap 12'): White Clip will be applied to Tap 12.
  • Tap13 (Display string: 'Tap 13'): White Clip will be applied to Tap 13.
  • Tap14 (Display string: 'Tap 14'): White Clip will be applied to Tap 14.
  • Tap15 (Display string: 'Tap 15'): White Clip will be applied to Tap 15.
  • Tap16 (Display string: 'Tap 16')
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.

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