Supported by ...


COLOR cameras only.  


Description


The White Shading feature provides control over the individual red, green and blue channel gains so that non-standard color balance can be achieved.  One-push Auto will attempt to white balance the gains (match the histogram peaks of the brightest area in each color channel) based on the image data in the current ROI. 


Note: The auto white shading algorithm is based on a brightfield microscopy where the background is bright and white.  The algorithm balances the brightest areas of the image to white. When used in reflected light microscopy or in colored environments, the brightest areas in the image must be neutral in color.  If not, it is best to perform the auto white shading using a grey card.


Note: White Shading is sometimes referred to as White Balance. In Pixelink Capture for instance, the controls for this feature can be found under White Balance Settings. 



White shading is performed prior to other image processing steps and is independent of the white balance (color correction) settings.


Setting a gain parameter to zero will effectively turn off that color channel – it will output a zero value.


Note: Setting a color channel gain to zero and also setting the saturation feature to zero will still result in values on that color channel. This is due to the fact that grey tones (from zero saturation) require equal output from all 3 color channels. The color channel gains affect the raw sensor data and any image processing performed on-board the camera, like the saturation adjustment, may modify the values on the color channels.


Note: If the FEAURE_AUTO_ROI has been set prior to performing an auto white shading, the white shading algorithm will be restricted to only using the portion of the image defined by the AUTO_ROI (which the user had previously defined on a ‘white’ area of the image).  


API Control


PxLGetFeaturePxLSetFeature


Feature
Number of Params
Parameters
 Units
Restrictions
FEATURE_WHITE_SHADING

Camera color channel gains

3
fRedGain
Decibels

(dB)

N/A
fGreenGain
Decibels

(dB)

N/A
fBlueGain
Decibels

(dB)

N/A



Feature Flags


Camera
Presence
Read Only
Auto
Manual
One-time Auto
Off
CiD
All Cameras
Yes
No
No
Yes
Yes
No
Yes



Parameters



Camera
Parameter
Unit
Type
Min
Max
Default
Step Size
PL-D721Cpy
Gain Red
None
Absolute
0
4
1.5
0.00001
Gain Green
None
Absolute
0
4
1
0.00001
Gain Blue
None
Absolute
0
4
1.6
0.00001
PL-D722C
Gain Red
None
Absolute
0
4
1.5
0.00001
Gain Green
None
Absolute
0
4
1
0.00001
Gain Blue
None
Absolute
0
4
1.6
0.00001
PL-D725C
Gain Red
None
Absolute
0
4
1.5
0.00001
Gain Green
None
Absolute
0
4
1
0.00001
Gain Blue
None
Absolute
0
4
1.6
0.00001
PL-D734C
Gain Red
None
Absolute
0
4
1
0.00001
Gain Green
None
Absolute
0
4
1
0.00001
Gain Blue
None
Absolute
0
4
1
0.00001
PL-D752C
Gain Red
None
Absolute
0
4
2.08
0.00001
Gain Green
None
Absolute
0
4
1
0.00001
Gain Blue
None
Absolute
0
4
1.33
0.00001
PL-D755C
Gain Red
None
Absolute
0
4
2.08
0.00001
Gain Green
None
Absolute
0
4
1
0.00001
Gain Blue
None
Absolute
0
4
1.33
0.00001
PL-D759C
Gain Red
None
Absolute
0
4
1.3
0.00001
Gain Green
None
Absolute
0
4
1
0.00001
Gain Blue
None
Absolute
0
4
2.5
0.00001
PL-D7512C
Gain Red
None
Absolute
0
4
2.08
0.00001
Gain Green
None
Absolute
0
4
1
0.00001
Gain Blue
None
Absolute
0
4
1.33
0.00001
PL-D7715C
Gain Red
None
Absolute
0
4
1.3
0.00001
Gain Green
None
Absolute
0
4
1
0.00001
Gain Blue
None
Absolute
0
4
1.5
0.00001
Pl-B742, 
PL-B681C
Gain Red
None
Absolute
0
4
1.06
0.0156
Gain Green
None
Absolute
0
4
1.0
0.0156
Gain Blue
None
Absolute
0
4
1.57
0.0156
PL-B762
Gain Red
None
Absolute
0
4
1.0
0.01
Gain Green
None
Absolute
0
4
1.0
0.01
Gain Blue
None
Absolute
0
4
2.0
0.01
PL-B774, 
PL-B776, PL-B778,

PL-B622C, 

PL-B623C, PL-B625C

Gain Red
None
Absolute
0
4
1.0
0.0156
Gain Green
None
Absolute
0
4
1.0
0.0156
Gain Blue
None
Absolute
0
4
1.73
0.0156
PL-B782, 
PL-B686C
Gain Red
None
Absolute
0
4
1.42
0.0156
Gain Green
None
Absolute
0
4
1.0
0.0156
Gain Blue
None
Absolute
0
4
1.08
0.0156
PL-B870C, 
PL-B950
Gain Red
None
Absolute
0
8
1.0
0.0312
Gain Green
None
Absolute
0
8
1.0
0.0312
Gain Blue
None
Absolute
0
8
2.0
0.0312