Impact Acquire SDK Python

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

Inheritance diagram for mvHDRControl:
[legend]

Public Member Functions

 __init__ (self, *args)
 Constructs a new mvIMPACT.acquire.mvHDRControl object.
 

Properties

 mvHDRAdaptiveLocalToneMappingEnable = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRAdaptiveLocalToneMappingEnable_get, doc=)
 A boolean property.
 
 mvHDREnable = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDREnable_get, doc=)
 A boolean property.
 
 mvHDRExposure1 = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRExposure1_get, doc=)
 An integer property.
 
 mvHDRExposure2 = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRExposure2_get, doc=)
 An integer property.
 
 mvHDRExposureRatio = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRExposureRatio_get, doc=)
 An enumerated integer property.
 
 mvHDRMotionCompensationEnable = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRMotionCompensationEnable_get, doc=)
 A boolean property.
 
 mvHDRPreset = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRPreset_get, doc=)
 An enumerated integer property.
 
 mvHDRSelector = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRSelector_get, doc=)
 An enumerated integer property.
 
 mvHDRVoltage1 = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRVoltage1_get, doc=)
 An integer property.
 
 mvHDRVoltage2 = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRVoltage2_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

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

◆ __init__()

__init__ ( self,
* args )

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

◆ mvHDRAdaptiveLocalToneMappingEnable

mvHDRAdaptiveLocalToneMappingEnable = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRAdaptiveLocalToneMappingEnable_get, doc=)
static

A boolean property.

Enables Adaptive Local Tone Mapping

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

◆ mvHDREnable

mvHDREnable = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDREnable_get, doc=)
static

A boolean property.

Enables the High Dynamic Range Feature.

Enables the High Dynamic Range Feature.

◆ mvHDRExposure1

mvHDRExposure1 = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRExposure1_get, doc=)
static

An integer property.

First HDR Exposure in ppm.

First HDR Exposure in ppm.

◆ mvHDRExposure2

mvHDRExposure2 = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRExposure2_get, doc=)
static

An integer property.

Second HDR Exposure in ppm.

Second HDR Exposure in ppm.

◆ mvHDRExposureRatio

mvHDRExposureRatio = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRExposureRatio_get, doc=)
static

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

◆ mvHDRMotionCompensationEnable

mvHDRMotionCompensationEnable = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRMotionCompensationEnable_get, doc=)
static

A boolean property.

Enables motion compensation

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

◆ mvHDRPreset

mvHDRPreset = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRPreset_get, doc=)
static

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

◆ mvHDRSelector

mvHDRSelector = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRSelector_get, doc=)
static

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

◆ mvHDRVoltage1

mvHDRVoltage1 = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRVoltage1_get, doc=)
static

An integer property.

First HDR Voltage in mV.

First HDR Voltage in mV.

◆ mvHDRVoltage2

mvHDRVoltage2 = property(lib_mvIMPACT_acquire.mvHDRControl_mvHDRVoltage2_get, doc=)
static

An integer property.

Second HDR Voltage in mV.

Second HDR Voltage in mV.

◆ thisown

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