Impact Acquire SDK Python
WhiteBalanceSettings Class Reference
Common

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

Inheritance diagram for WhiteBalanceSettings:
[legend]

Public Member Functions

 __init__ (self, *args, **kwargs)
 hObj (self)
 Returns a unique identifier for the component collection referenced by this object.
 restoreDefault (self)
 Restores the default for every component of this collection.

Properties

 aoiHeight = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_aoiHeight_get, doc=)
 An integer property defining the height of the AOI in pixel to be used for the calculation.
 aoiStartX = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_aoiStartX_get, doc=)
 An integer property defining the X-offset of the AOI in pixel to be used for the calculation.
 aoiStartY = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_aoiStartY_get, doc=)
 An integer property defining the Y-offset of the AOI in pixel to be used for the calculation.
 aoiWidth = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_aoiWidth_get, doc=)
 An integer property defining the width of the AOI in pixel to be used for the calculation.
 blueGain = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_blueGain_get, doc=)
 A float property defining the gain for the blue channel.
 greenGain = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_greenGain_get, doc=)
 A float property defining the gain for the green channel.
 redGain = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_redGain_get, doc=)
 A float property defining the gain for the red channel.
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 totalGain = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_totalGain_get, doc=)
 A float property defining the overall gain.
 WBAoiMode = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_WBAoiMode_get, doc=)
 An enumerated integer property defining the which area of the image is used for the calculation of the parameters.
 WBResult = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_WBResult_get, doc=)
 An enumerated integer property (read-only) containing the result of the last white balance calibration.

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.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
* args,
** kwargs )

Member Function Documentation

◆ hObj()

hObj ( self)
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()

restoreDefault ( self)
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.

Property Documentation

◆ aoiHeight

aoiHeight = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_aoiHeight_get, doc=)
static

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

aoiStartX = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_aoiStartX_get, doc=)
static

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

aoiStartY = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_aoiStartY_get, doc=)
static

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

aoiWidth = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_aoiWidth_get, doc=)
static

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

blueGain = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_blueGain_get, doc=)
static

A float property defining the gain for the blue channel.

◆ greenGain

greenGain = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_greenGain_get, doc=)
static

A float property defining the gain for the green channel.

◆ redGain

redGain = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_redGain_get, doc=)
static

A float property defining the gain for the red channel.

◆ thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

◆ totalGain

totalGain = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_totalGain_get, doc=)
static

A float property defining the overall gain.

◆ WBAoiMode

WBAoiMode = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_WBAoiMode_get, doc=)
static

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

Valid values for this property may be: mvIMPACT.acquire.amCentered, mvIMPACT.acquire.amFull, mvIMPACT.acquire.amUseAoi.

◆ WBResult

WBResult = property(lib_mvIMPACT_acquire.WhiteBalanceSettings_WBResult_get, doc=)
static

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 may be: mvIMPACT.acquire.bwbrUnknown, mvIMPACT.acquire.bwbrOK, mvIMPACT.acquire.bwbrErrorUnknown, mvIMPACT.acquire.bwbrErrorTooDark, mvIMPACT.acquire.bwbrErrorTooBright.