mvIMPACT Acquire SDK C++
ColorTransformationControl Class Reference

Category that contains the Color Transformation control features. More...

#include <mvIMPACT_acquire_GenICam.h>

Public Member Functions

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

Public Attributes

PropertyIBoolean colorTransformationEnable
 A boolean property. Activates the selected Color Transformation module.
 
PropertyI64 colorTransformationSelector
 An enumerated integer property. Selects which Color Transformation module is controlled by the various Color Transformation features.
 
PropertyF colorTransformationValue
 A floating point property. Represents the value of the selected Gain factor or Offset inside the Transformation matrix.
 
PropertyI64 colorTransformationValueSelector
 An enumerated integer property. Selects the Gain factor or Offset of the Transformation matrix to access in the selected Color Transformation module.
 

Detailed Description

Category that contains the Color Transformation control features.

A category that contains the Color Transformation control features.

Constructor & Destructor Documentation

◆ ColorTransformationControl()

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

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

◆ colorTransformationEnable

PropertyIBoolean colorTransformationEnable

A boolean property. Activates the selected Color Transformation module.

Activates the selected Color Transformation module.

◆ colorTransformationSelector

PropertyI64 colorTransformationSelector

An enumerated integer property. Selects which Color Transformation module is controlled by the various Color Transformation features.

Selects which Color Transformation module is controlled by the various Color Transformation features.

The following string values might be valid for this feature:

  • RGBtoRGB (Display string: 'RGB to RGB'): RGB to RGB color transformation.
  • RGBtoYUV (Display string: 'RGB to YUV'): RGB to YUV color transformation.
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.

◆ colorTransformationValue

PropertyF colorTransformationValue

A floating point property. Represents the value of the selected Gain factor or Offset inside the Transformation matrix.

Represents the value of the selected Gain factor or Offset inside the Transformation matrix.

◆ colorTransformationValueSelector

PropertyI64 colorTransformationValueSelector

An enumerated integer property. Selects the Gain factor or Offset of the Transformation matrix to access in the selected Color Transformation module.

Selects the Gain factor or Offset of the Transformation matrix to access in the selected Color Transformation module.

The following string values might be valid for this feature:

  • Gain00 (Display string: 'Gain 00'): Gain 0,0 of the transformation matrix.
  • Gain01 (Display string: 'Gain 01'): Gain 0,1 of the transformation matrix.
  • Gain02 (Display string: 'Gain 02'): Gain 0,2 of the transformation matrix.
  • Gain10 (Display string: 'Gain 10'): Gain 1,0 of the transformation matrix.
  • Gain11 (Display string: 'Gain 11'): Gain 1,1 of the transformation matrix.
  • Gain12 (Display string: 'Gain 12'): Gain 1,2 of the transformation matrix.
  • Gain20 (Display string: 'Gain 20'): Gain 2,0 of the transformation matrix.
  • Gain21 (Display string: 'Gain 21'): Gain 2,1 of the transformation matrix.
  • Gain22 (Display string: 'Gain 22'): Gain 2,2 of the transformation matrix.
  • Offset0 (Display string: 'Offset 0'): Offset 0 of the transformation matrix.
  • Offset1 (Display string: 'Offset 1'): Offset 1 of the transformation matrix.
  • Offset2 (Display string: 'Offset 2'): Offset 2 of the transformation matrix.
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.