WhiteBalanceSettings Class Reference

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

Inheritance diagram for WhiteBalanceSettings:

Public Member Functions
IEnumerable< T >	getEnumerable< T > ()
	Returns an enumerator of a certain type that iterates through the collection.
IEnumerator< int >	GetEnumerator ()
	Returns an enumerator that iterates through the collection.
void	restoreDefault ()
	Restores the default for every component of this collection.

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

Properties
IEnumerable< Component >	componentEnumerable [get]
	Returns an enumerator that iterates through the collection.
IEnumerable< ComponentList >	componentListEnumerable [get]
	Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.
int	hObj [get]
	Returns a unique identifier for the component collection referenced by this object.

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 mv.impact.acquire.ImageProcessing.

Member Function Documentation

getEnumerable< T >()

IEnumerable< T > getEnumerable< T > ( )

inlineinherited

Returns an enumerator of a certain type that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Property c in info.getEnumerable<Property>())
{
  validateProperty(c);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

GetEnumerator()

IEnumerator< int > GetEnumerator ( )

inlineinherited

Returns an enumerator that iterates through the collection.

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

restoreDefault()

void restoreDefault ( )

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.

Member Data Documentation

aoiHeight

readonly PropertyI aoiHeight = new PropertyI()

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 mv.impact.acquire.WhiteBalanceSettings.WBAoiMode is set to mv.impact.acquire.TAoiMode.amUseAoi.

aoiStartX

readonly PropertyI aoiStartX = new PropertyI()

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 mv.impact.acquire.WhiteBalanceSettings.WBAoiMode is set to mv.impact.acquire.TAoiMode.amUseAoi.

aoiStartY

readonly PropertyI aoiStartY = new PropertyI()

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 mv.impact.acquire.WhiteBalanceSettings.WBAoiMode is set to mv.impact.acquire.TAoiMode.amUseAoi.

aoiWidth

readonly PropertyI aoiWidth = new PropertyI()

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 mv.impact.acquire.WhiteBalanceSettings.WBAoiMode is set to mv.impact.acquire.TAoiMode.amUseAoi.

blueGain

readonly PropertyF blueGain = new PropertyF()

A float property defining the gain for the blue channel.

greenGain

readonly PropertyF greenGain = new PropertyF()

A float property defining the gain for the green channel.

redGain

readonly PropertyF redGain = new PropertyF()

A float property defining the gain for the red channel.

totalGain

readonly PropertyF totalGain = new PropertyF()

A float property defining the overall gain.

WBAoiMode

readonly EnumPropertyI<TAoiMode> WBAoiMode = new EnumPropertyI<TAoiMode>()

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 mv.impact.acquire.TAoiMode.

WBResult

readonly EnumPropertyI<TBayerWhiteBalanceResult> WBResult = new EnumPropertyI<TBayerWhiteBalanceResult>()

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

After the mv.impact.acquire.Device has been initialised, the value of this property will be mv.impact.acquire.TBayerWhiteBalanceResult.bwbrUnknown.

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

Property Documentation

componentEnumerable

IEnumerable<Component> componentEnumerable

getinherited

Returns an enumerator that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Component c in info.componentEnumerable)
{
  Console.WriteLine("{0}", c.name);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

componentListEnumerable

IEnumerable<ComponentList> componentListEnumerable

getinherited

Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (ComponentList cl in info.componentListEnumerable)
{
  Console.WriteLine("{0}", cl.name);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

hObj

int hObj

getinherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mv.impact.acquire.ComponentList.

Returns

A unique identifier for the component referenced by this object.