BalanceRatio
Top  Previous  Next

Description

Returns or sets the ratio (amplification factor) of the selected color component in absolute or raw units. Used for white balancing.


Syntax


[VB]
objActiveGige.BalanceRatio [= Value]


[C/C++]
HRESULT get_BalanceRatio( float *pValue );
HRESULT put_BalanceRatio( float Value );



Data Type
[VB]

Single

Parameters
[C/C++]

pValue [out,retval]  
Pointer to the white balance ratio  
Value [in]  
The white balance ratio to be set  


Return Values


S_OK  
Success  
E_NOINTERFACE        
The feature is not available for the selected camera  
E_INVALIDARG  
The value is out of range  
E_FAIL  
Failure to set the feature value  
 

Example


The following VB example adjusts white balance factors for different color channels:

ActiveGige1.BalanceRatioSelector="Red"
ActiveGige1.BalanceRatio = 1.2
ActiveGige1.BalanceRatioSelector="Green"
ActiveGige1.BalanceRatio = 1.4
ActiveGige1.BalanceRatioSelector="Blue"
ActiveGige1.BalanceRatio = 1.
 

Remarks


This property changes the ratio of the selected color component relative to the base level of the component. The valid range of the ratio values can be obtained by the GetBalanceRatioMin and GetBalanceRatioMax methods. Before using BalanceRatio, select a corresponding channel with BalanceRatioSelector.

Note that the property is available only if the currently selected camera supports one of the following GenICam features: BalanceRatio, BalanceRatioAbs, BalanceRatioRaw.