# GetWhiteBalanceGain

Available for color In-Sight 3800 series vision systems only, the GetWhiteBalanceGain 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 check the gain value of the specified color channel (red, green, or blue) in a white balanced image.

The function returns the gain value of the specified color channel as a float.

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

## GetWhiteBalanceGain Inputs

The GetWhiteBalanceGain function has a single parameter listed in its Property Sheet.

Parameter | Description
--- | ---
Color Channel | Specifies the color channel whose gain value will be checked: Red = 0 Green = 1 Blue = 2

### GetWhiteBalanceGain Outputs

Parameter | Description
--- | ---
Returns | The gain value of the specified color channel as a float.

### GetWhiteBalanceGain Vision Data Access functions

The GetWhiteBalanceGain tool has no specific Vision Data Access functions.