mvIMPACT Acquire SDK C++
WhiteBalanceSettings Class Reference

Properties for adjusting the colors during a Bayer conversion. More...

Inheritance diagram for WhiteBalanceSettings:
ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyI aoiHeight
 An integer property defining the height of the AOI in pixel to be used for the calculation. More...
 
PropertyI aoiStartX
 An integer property defining the X-offset of the AOI in pixel to be used for the calculation. More...
 
PropertyI aoiStartY
 An integer property defining the Y-offset of the AOI in pixel to be used for the calculation. More...
 
PropertyI aoiWidth
 An integer property defining the width of the AOI in pixel to be used for the calculation. More...
 
PropertyF blueGain
 A float property defining the gain for the blue channel. More...
 
PropertyF greenGain
 A float property defining the gain for the green channel. More...
 
PropertyF redGain
 A float property defining the gain for the red channel. More...
 
PropertyF totalGain
 A float property defining the overall gain. More...
 
PropertyIAoiMode WBAoiMode
 An enumerated integer property defining the which area of the image is used. More...
 
PropertyIBayerWhiteBalanceResult WBResult
 An enumerated integer property (read-only) containing the result of the last white balance calibration. More...
 

Protected Attributes

HOBJ m_hRoot
 

Friends

class ImageProcessing
 

Detailed Description

Properties for adjusting the colors during a Bayer conversion.

This class provides properties to adjust the parameters needed for a Bayer conversion.

Note
Objects of this class can't be constructed directly. Its parameters can be accessed via an instance of a class derived from mvIMPACT::acquire::ImageProcessing.

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.

Friends And Related Function Documentation

◆ ImageProcessing

friend class ImageProcessing
friend

Member Data Documentation

◆ aoiHeight

PropertyI aoiHeight

An integer property defining the height of the AOI in pixel to be used for the calculation.

Note
This property will be visible only when mvIMPACT::acquire::WhiteBalanceSettings::WBAoiMode is set to mvIMPACT::acquire::amUseAoi.

◆ aoiStartX

PropertyI aoiStartX

An integer property defining the X-offset of the AOI in pixel to be used for the calculation.

Note
This property will be visible only when mvIMPACT::acquire::WhiteBalanceSettings::WBAoiMode is set to mvIMPACT::acquire::amUseAoi.

◆ aoiStartY

PropertyI aoiStartY

An integer property defining the Y-offset of the AOI in pixel to be used for the calculation.

Note
This property will be visible only when mvIMPACT::acquire::WhiteBalanceSettings::WBAoiMode is set to mvIMPACT::acquire::amUseAoi.

◆ aoiWidth

PropertyI aoiWidth

An integer property defining the width of the AOI in pixel to be used for the calculation.

Note
This property will be visible only when mvIMPACT::acquire::WhiteBalanceSettings::WBAoiMode is set to mvIMPACT::acquire::amUseAoi.

◆ blueGain

PropertyF blueGain

A float property defining the gain for the blue channel.

◆ greenGain

PropertyF greenGain

A float property defining the gain for the green channel.

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ redGain

PropertyF redGain

A float property defining the gain for the red channel.

◆ totalGain

PropertyF totalGain

A float property defining the overall gain.

◆ WBAoiMode

PropertyIAoiMode WBAoiMode

An enumerated integer property defining the which area of the image is used.

for the calculation of the parameters.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TAoiMode.

◆ WBResult

An enumerated integer property (read-only) containing the result of the last white balance calibration.

After the mvIMPACT::acquire::Device has been initialized, the value of this property will be mvIMPACT::acquire::bwbrUnknown.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBayerWhiteBalanceResult.


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