# SetWhiteBalanceGains

Available for color In-Sight 3800 series vision systems only, the SetWhiteBalanceGains function Functions are tools that are available in Spreadsheet for processing and analyzing acquisitions or other results. You can add functions to your Spreadsheet job to create tool chains and produce results for specific applications. 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 Spreadsheet Toolbox. To open the SetWhiteBalanceGain Property Sheet and configure it, type SetWhiteBalanceGains() into a Spreadsheet cell.

## Inputs

The SetWhiteBalanceGain function has the following syntax:

SetWhiteBalanceGain(Color Channel, Gain Value)

See the table for a description of the available parameters.

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.

Outputs

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

Vision Data Access functions

The SetWhiteBalanceGains tool has no specific Vision Data Access functions.