mvIMPACT Acquire SDK C++

Category that contains features to control the devices High Dynamic Range parameters. More...

Inheritance diagram for mvHDRControl:
ComponentCollection

Public Member Functions

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

Public Attributes

PropertyIBoolean mvHDRAdaptiveLocalToneMappingEnable
 A boolean property. Enables Adaptive Local Tone Mapping. More...
 
PropertyIBoolean mvHDREnable
 A boolean property. Enables the High Dynamic Range Feature. More...
 
PropertyI64 mvHDRExposure1
 An integer property. First HDR Exposure in ppm. More...
 
PropertyI64 mvHDRExposure2
 An integer property. Second HDR Exposure in ppm. More...
 
PropertyI64 mvHDRExposureRatio
 An enumerated integer property. T1/T2 Exposure Ratio. More...
 
PropertyIBoolean mvHDRMotionCompensationEnable
 A boolean property. Enables motion compensation. More...
 
PropertyI64 mvHDRPreset
 An enumerated integer property. Selects the HDR parameter set. More...
 
PropertyI64 mvHDRSelector
 An enumerated integer property. Selects the HDR parameter set to configure. More...
 
PropertyI64 mvHDRVoltage1
 An integer property. First HDR Voltage in mV. More...
 
PropertyI64 mvHDRVoltage2
 An integer property. Second HDR Voltage in mV. More...
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

Category that contains features to control the devices High Dynamic Range parameters.

A category that contains features to control the devices High Dynamic Range parameters.

Constructor & Destructor Documentation

◆ mvHDRControl()

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

Constructs a new mvIMPACT::acquire::GenICam::mvHDRControl 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

◆ mvHDRAdaptiveLocalToneMappingEnable

PropertyIBoolean mvHDRAdaptiveLocalToneMappingEnable

A boolean property. Enables Adaptive Local Tone Mapping.

Enables Adaptive Local Tone Mapping. Recommended if mvHDRMotionCompensationEnable is enabled.

◆ mvHDREnable

PropertyIBoolean mvHDREnable

A boolean property. Enables the High Dynamic Range Feature.

Enables the High Dynamic Range Feature.

◆ mvHDRExposure1

PropertyI64 mvHDRExposure1

An integer property. First HDR Exposure in ppm.

First HDR Exposure in ppm.

◆ mvHDRExposure2

PropertyI64 mvHDRExposure2

An integer property. Second HDR Exposure in ppm.

Second HDR Exposure in ppm.

◆ mvHDRExposureRatio

PropertyI64 mvHDRExposureRatio

An enumerated integer property. T1/T2 Exposure Ratio.

The ratio of the long exposure time to the short exposure time.

The following string values might be valid for this feature:

  • mvRatio4x (Display string: 'mv Ratio 4x')
  • mvRatio8x (Display string: 'mv Ratio 8x')
  • mvRatio16x (Display string: 'mv Ratio 16x')
  • mvRatio32x (Display string: 'mv Ratio 32x')
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.

◆ mvHDRMotionCompensationEnable

PropertyIBoolean mvHDRMotionCompensationEnable

A boolean property. Enables motion compensation.

Enables motion compensation. Recommended for scenes with a lot of motion.

◆ mvHDRPreset

PropertyI64 mvHDRPreset

An enumerated integer property. Selects the HDR parameter set.

Selects the HDR parameter set.

The following string values might be valid for this feature:

  • mvDualKneePoint0 (Display string: 'mv Dual Knee Point 0')
  • mvDualKneePoint1 (Display string: 'mv Dual Knee Point 1')
  • mvDualKneePoint2 (Display string: 'mv Dual Knee Point 2')
  • mvDualKneePoint3 (Display string: 'mv Dual Knee Point 3')
  • mvDualKneePoint4 (Display string: 'mv Dual Knee Point 4')
  • mvDualKneePoint5 (Display string: 'mv Dual Knee Point 5')
  • mvDualKneePoint6 (Display string: 'mv Dual Knee Point 6')
  • mvDualKneePointUser (Display string: 'mv Dual Knee Point 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.

◆ mvHDRSelector

PropertyI64 mvHDRSelector

An enumerated integer property. Selects the HDR parameter set to configure.

This enumeration selects the HDR parameter set to configure.

The following string values might be valid for this feature:

  • mvDualKneePoint0 (Display string: 'mv Dual Knee Point 0')
  • mvDualKneePoint1 (Display string: 'mv Dual Knee Point 1')
  • mvDualKneePoint2 (Display string: 'mv Dual Knee Point 2')
  • mvDualKneePoint3 (Display string: 'mv Dual Knee Point 3')
  • mvDualKneePoint4 (Display string: 'mv Dual Knee Point 4')
  • mvDualKneePoint5 (Display string: 'mv Dual Knee Point 5')
  • mvDualKneePoint6 (Display string: 'mv Dual Knee Point 6')
  • mvDualKneePointUser (Display string: 'mv Dual Knee Point 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.

◆ mvHDRVoltage1

PropertyI64 mvHDRVoltage1

An integer property. First HDR Voltage in mV.

First HDR Voltage in mV.

◆ mvHDRVoltage2

PropertyI64 mvHDRVoltage2

An integer property. Second HDR Voltage in mV.

Second HDR Voltage in mV.


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