WhiteBalanceSettings Class Reference

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

Inheritance diagram for WhiteBalanceSettings:

Public Member Functions
synchronized void	delete ()
PropertyI	getAoiHeight ()
	An integer property defining the height of the AOI in pixel to be used for the calculation.
PropertyI	getAoiStartX ()
	An integer property defining the X-offset of the AOI in pixel to be used for the calculation.
PropertyI	getAoiStartY ()
	An integer property defining the Y-offset of the AOI in pixel to be used for the calculation.
PropertyI	getAoiWidth ()
	An integer property defining the width of the AOI in pixel to be used for the calculation.
PropertyF	getBlueGain ()
	A float property defining the gain for the blue channel.
PropertyF	getGreenGain ()
	A float property defining the gain for the green channel.
PropertyF	getRedGain ()
	A float property defining the gain for the red channel.
PropertyF	getTotalGain ()
	A float property defining the overall gain.
PropertyI	getWBAoiMode ()
	An enumerated integer property defining the which area of the image is used for the calculation of the parameters.
PropertyI	getWBResult ()
	An enumerated integer property (read-only) containing the result of the last white balance calibration.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
void	finalize ()
	WhiteBalanceSettings (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)
static long	swigRelease (WhiteBalanceSettings obj)

Protected Attributes
transient boolean	swigCMemOwn

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

WhiteBalanceSettings()

WhiteBalanceSettings ( long cPtr, boolean cMemoryOwn )

protected

Member Function Documentation

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getAoiHeight()

PropertyI getAoiHeight

(

)

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.getWBAoiMode() is set to mvIMPACT.acquire.TAoiMode.amUseAoi.

getAoiStartX()

PropertyI getAoiStartX

(

)

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.getWBAoiMode() is set to mvIMPACT.acquire.TAoiMode.amUseAoi.

getAoiStartY()

PropertyI getAoiStartY

(

)

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.getWBAoiMode() is set to mvIMPACT.acquire.TAoiMode.amUseAoi.

getAoiWidth()

PropertyI getAoiWidth

(

)

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.getWBAoiMode() is set to mvIMPACT.acquire.TAoiMode.amUseAoi.

getBlueGain()

PropertyF getBlueGain

(

)

A float property defining the gain for the blue channel.

getGreenGain()

PropertyF getGreenGain

(

)

A float property defining the gain for the green channel.

getRedGain()

PropertyF getRedGain

(

)

A float property defining the gain for the red channel.

getTotalGain()

PropertyF getTotalGain

(

)

A float property defining the overall gain.

getWBAoiMode()

PropertyI getWBAoiMode

(

)

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.

getWBResult()

PropertyI getWBResult

(

)

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.TBayerWhiteBalanceResult.bwbrUnknown.

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

hObj()

int hObj ( )

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

ComponentCollection restoreDefault ( )

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.

swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

swigRelease() [2/2]

static long swigRelease ( WhiteBalanceSettings obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited