mvIMPACT Acquire SDK C++
mvFrameAverageControl Class Reference

Category that contains features to control the frame averaging engine. More...

Inheritance diagram for mvFrameAverageControl:
ComponentCollection

Public Member Functions

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

Public Attributes

PropertyI64 mvFrameAverageDynamicMode
 An enumerated integer property. Sets the frame average dynamic operating mode. More...
 
PropertyIBoolean mvFrameAverageEnable
 A boolean property. Enables the frame averaging engine. More...
 
PropertyI64 mvFrameAverageFrameCount
 An integer property. Here you specify the frame count used for the calculation of the frame average. More...
 
PropertyI64 mvFrameAverageMode
 An enumerated integer property. Sets the frame average operating mode. More...
 
PropertyI64 mvFrameAverageNoiseGain
 An integer property. Here you specify the noise border for very bright pictures. More...
 
PropertyI64 mvFrameAverageNoiseLimit
 An integer property. Here you specify the noise limit for very bright pictures. More...
 
PropertyI64 mvFrameAverageSlope
 An integer property. Here you specify the noise border for very dark pictures. More...
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

Category that contains features to control the frame averaging engine.

A category that contains features to control the frame averaging engine.

Constructor & Destructor Documentation

◆ mvFrameAverageControl()

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

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

◆ mvFrameAverageDynamicMode

PropertyI64 mvFrameAverageDynamicMode

An enumerated integer property. Sets the frame average dynamic operating mode.

Sets the frame average dynamic operating mode.

The following string values might be valid for this feature:

  • mvStandard (Display string: 'mv Standard')
  • mvGauss (Display string: 'mv Gauss')
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.

◆ mvFrameAverageEnable

PropertyIBoolean mvFrameAverageEnable

A boolean property. Enables the frame averaging engine.

Enables the frame averaging engine.

◆ mvFrameAverageFrameCount

PropertyI64 mvFrameAverageFrameCount

An integer property. Here you specify the frame count used for the calculation of the frame average.

Here you specify the frame count used for the calculation of the frame average.

◆ mvFrameAverageMode

PropertyI64 mvFrameAverageMode

An enumerated integer property. Sets the frame average operating mode.

Sets the frame average operating mode.

The following string values might be valid for this feature:

  • mvPlain (Display string: 'mv Plain')
  • mvDynamic (Display string: 'mv Dynamic')
  • mvNTo1 (Display string: 'mv N To 1')
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.

◆ mvFrameAverageNoiseGain

PropertyI64 mvFrameAverageNoiseGain

An integer property. Here you specify the noise border for very bright pictures.

Here you specify the noise border for very bright pictures.

◆ mvFrameAverageNoiseLimit

PropertyI64 mvFrameAverageNoiseLimit

An integer property. Here you specify the noise limit for very bright pictures.

Here you specify the noise limit for very bright pictures.

◆ mvFrameAverageSlope

PropertyI64 mvFrameAverageSlope

An integer property. Here you specify the noise border for very dark pictures.

Here you specify the noise border for very dark pictures.


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