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

#include <mvIMPACT_acquire.h>

Inheritance diagram for WhiteBalanceSettings:

Public Member Functions
HOBJ	hObj (void) const
	Returns a unique identifier for the component collection referenced by this object.

const ComponentCollection &	restoreDefault (void) const
	Restores the default for every component of this collection.

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

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

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

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

PropertyF	blueGain
	A float property defining the gain for the blue channel.

PropertyF	greenGain
	A float property defining the gain for the green channel.

PropertyF	redGain
	A float property defining the gain for the red channel.

PropertyF	totalGain
	A float property defining the overall gain.

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

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

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

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

Public Member Functions

Public Attributes

Protected Attributes

Friends