SetWhiteBalanceGain

Available for color In-Sight D900 series vision systems only, the SetWhiteBalanceGain function is used to configure the gain value of the specified color channel (red, green, or blue) in a white balanced image.

Note: The SetWhiteBalanceGain function is not listed in the Toolbox. To open its Property Sheet and configure it, type SetWhiteBalanceGain() into a Spreadsheet cell.

SetWhiteBalanceGain Inputs

The SetWhiteBalanceGain function has the following parameters listed in its Property Sheet.

Parameter	Description
Color Channel	Specifies the color channel whose gain value will be set: Red = 0 Green = 1 Blue = 2
Gain Value	Specifies the gain value to set for the channel specified with the Color Channel parameter. The value is a float, with a range of 1 to 255. The default value is 1.

Parameter

Description

Color Channel

Specifies the color channel whose gain value will be set:

Red = 0
Green = 1
Blue = 2

Gain Value

Specifies the gain value to set for the channel specified with the Color Channel parameter. The value is a float, with a range of 1 to 255. The default value is 1.

SetWhiteBalanceGain Outputs

Parameter	Description
Returns	A ❒SetWhiteBalanceGain structure, containing the configured gain value of the specified color channel. Double-click the structure to open the tool's Property Sheet again.

SetWhiteBalanceGain Vision Data Access Functions

The SetWhiteBalanceGain tool has no specific Vision Data Access Functions.