Impact Acquire SDK Java
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
mvHDRControl Class Reference
GenICam Interface Layout » GenICam Interface Layout (Device)

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

Inheritance diagram for mvHDRControl:
[legend]

Public Member Functions

synchronized void delete ()
 
PropertyI getMvHDRAdaptiveLocalToneMappingEnable ()
 A boolean property.
 
PropertyI getMvHDREnable ()
 A boolean property.
 
PropertyI64 getMvHDRExposure1 ()
 An integer property.
 
PropertyI64 getMvHDRExposure2 ()
 An integer property.
 
PropertyI64 getMvHDRExposureRatio ()
 An enumerated integer property.
 
PropertyI getMvHDRMotionCompensationEnable ()
 A boolean property.
 
PropertyI64 getMvHDRPreset ()
 An enumerated integer property.
 
PropertyI64 getMvHDRSelector ()
 An enumerated integer property.
 
PropertyI64 getMvHDRVoltage1 ()
 An integer property.
 
PropertyI64 getMvHDRVoltage2 ()
 An integer property.
 
int hObj ()
 Returns a unique identifier for the component collection referenced by this object.
 
 mvHDRControl (Device pDev)
 Constructs a new mvIMPACT.acquire.mvHDRControl object.
 
 mvHDRControl (Device pDev, String settingName)
 Constructs a new mvIMPACT.acquire.mvHDRControl object.
 
ComponentCollection restoreDefault ()
 Restores the default for every component of this collection.
 

Protected Member Functions

void finalize ()
 
 mvHDRControl (long cPtr, boolean cMemoryOwn)
 

Static Protected Member Functions

static long swigRelease (ComponentCollection obj)
 
static long swigRelease (mvHDRControl obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

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() [1/3]

mvHDRControl ( long cPtr,
boolean cMemoryOwn )
protected

◆ mvHDRControl() [2/3]

mvHDRControl ( Device pDev,
String settingName )

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

◆ mvHDRControl() [3/3]

mvHDRControl ( Device pDev)

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

◆ getMvHDRAdaptiveLocalToneMappingEnable()

PropertyI getMvHDRAdaptiveLocalToneMappingEnable ( )

A boolean property.

Enables Adaptive Local Tone Mapping

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

◆ getMvHDREnable()

PropertyI getMvHDREnable ( )

A boolean property.

Enables the High Dynamic Range Feature.

Enables the High Dynamic Range Feature.

◆ getMvHDRExposure1()

PropertyI64 getMvHDRExposure1 ( )

An integer property.

First HDR Exposure in ppm.

First HDR Exposure in ppm.

◆ getMvHDRExposure2()

PropertyI64 getMvHDRExposure2 ( )

An integer property.

Second HDR Exposure in ppm.

Second HDR Exposure in ppm.

◆ getMvHDRExposureRatio()

PropertyI64 getMvHDRExposureRatio ( )

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.

◆ getMvHDRMotionCompensationEnable()

PropertyI getMvHDRMotionCompensationEnable ( )

A boolean property.

Enables motion compensation

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

◆ getMvHDRPreset()

PropertyI64 getMvHDRPreset ( )

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.

◆ getMvHDRSelector()

PropertyI64 getMvHDRSelector ( )

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.

◆ getMvHDRVoltage1()

PropertyI64 getMvHDRVoltage1 ( )

An integer property.

First HDR Voltage in mV.

First HDR Voltage in mV.

◆ getMvHDRVoltage2()

PropertyI64 getMvHDRVoltage2 ( )

An integer property.

Second HDR Voltage in mV.

Second HDR Voltage in mV.

◆ 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 ( mvHDRControl obj)
staticprotected

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn
protectedinherited