IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.
Sets the target value for brightness auto features like ExposureAuto and GainAuto. The percentage of pixels, that must be brighter than BrightnessAutoTarget, is defined in BrightnessAutoPercentile.
Increasing BrightnessAutoTarget results in brighter images, decreasing its value results in darker images. If BrightnessAutoTarget is set to a high value and BrightnessAutoPercentile is set to its minimum, it behaves similar to a peak white algorithm. |
It is not recommended to push BrightnessAutoTarget to its limits. Keep distance from the limits, i.e. use "250" instead of "255", or "5" instead of "0". |
Name |
BrightnessAutoTarget |
Category |
|
Interface |
Integer |
Access |
Read/Write |
Unit |
- |
Visibility |
Expert |
Values |
8-bit: BrightnessAutoTargetTolerance ... (256-BrightnessAutoTargetTolerance), increment: 1 10-bit: BrightnessAutoTargetTolerance ... (1024-BrightnessAutoTargetTolerance), increment: 4 12-bit: BrightnessAutoTargetTolerance ... (4096-BrightnessAutoTargetTolerance), increment: 16 |
Standard |
IDS |
Availability uEye+ |
|
Availability uEye |
- |
Values description
The value of BrightnessAutoTarget relates to the current PixelFormat. Changing the PixelFormat will automatically adapt the value of BrightnessAutoTarget.
Example:
•PixelFormat: "Mono8"
→ BrightnessAutoTarget: "150"
•PixelFormat: "Mono10"
→ BrightnessAutoTarget: "600"
•PixelFormat: "Mono12"
→ BrightnessAutoTarget: "2400"
Code example
C++
// Determine the current BrightnessAutoTarget
int64_t value = nodeMapRemoteDevice->FindNode<peak::core::nodes::IntegerNode>("BrightnessAutoTarget")->Value();
// Set BrightnessAutoTarget to 150
nodeMapRemoteDevice->FindNode<peak::core::nodes::IntegerNode>("BrightnessAutoTarget")->SetValue(150);
C#
// Determine the current BrightnessAutoTarget
long value = nodeMapRemoteDevice.FindNode<peak.core.nodes.IntegerNode>("BrightnessAutoTarget").Value();
// Set BrightnessAutoTarget to 150
nodeMapRemoteDevice.FindNode<peak.core.nodes.IntegerNode>("BrightnessAutoTarget").SetValue(150);
Python
# Determine the current BrightnessAutoTarget (int)
value = nodeMapRemoteDevice.FindNode("BrightnessAutoTarget").Value()
# Set BrightnessAutoTarget to 150 (int)
nodeMapRemoteDevice.FindNode("BrightnessAutoTarget").SetValue(150)