IDS peak 2.10.0 / uEye+ firmware 3.34

IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.

Controls the mode for automatic white balancing between the color channels "DigitalRed", "DigitalGreen" and "DigitalBlue". The white balancing ratios are adjusted automatically. The image section that is used for the calculation is defined in SubRegionControl.

Values description

•Off: Disables BalanceWhiteAuto.

•Once: The camera adjusts the white balance once. BalanceWhiteAuto automatically returns to "Off" when convergence is achieved.

•Continuous: The camera adjusts the white balance continously.

Code example

C++

// Determine the current entry of BalanceWhiteAuto
std::string value = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("BalanceWhiteAuto")->CurrentEntry()->SymbolicValue();
// Get a list of all available entries of BalanceWhiteAuto
auto allEntries = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("BalanceWhiteAuto")->Entries();
std::vector<std::shared_ptr<peak::core::nodes::EnumerationEntryNode>> availableEntries;
for(const auto & entry : allEntries)
{
  if ((entry->AccessStatus()!=peak::core::nodes::NodeAccessStatus::NotAvailable)
          && (entry->AccessStatus()!=peak::core::nodes::NodeAccessStatus::NotImplemented))
  {
      availableEntries.emplace_back(entry);
  }
}
// Set BalanceWhiteAuto to "Off"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("BalanceWhiteAuto")->SetCurrentEntry("Off");

C#

// Determine the current entry of BalanceWhiteAuto
string value = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("BalanceWhiteAuto").CurrentEntry().SymbolicValue();
// Get a list of all available entries of BalanceWhiteAuto
allEntries = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("BalanceWhiteAuto").Entries();
List<string> availableEntries = new List<string>();
for(int i = 0; i < allEntries.Count(); ++i)
{
  if ((allEntries[i].AccessStatus() != peak.core.nodes.NodeAccessStatus.NotAvailable)
          && (allEntries[i].AccessStatus() != peak.core.nodes.NodeAccessStatus.NotImplemented))
  {
      availableEntries.Add(allEntries[i].SymbolicValue());
  }
}
// Set BalanceWhiteAuto to "Off"
nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("BalanceWhiteAuto").SetCurrentEntry("Off");

Python

# Determine the current entry of BalanceWhiteAuto (str)
value = nodeMapRemoteDevice.FindNode("BalanceWhiteAuto").CurrentEntry().SymbolicValue()
# Get a list of all available entries of BalanceWhiteAuto
allEntries = nodeMapRemoteDevice.FindNode("BalanceWhiteAuto").Entries()
availableEntries = []
for entry in allEntries:
  if (entry.AccessStatus() != ids_peak.NodeAccessStatus_NotAvailable
          and entry.AccessStatus() != ids_peak.NodeAccessStatus_NotImplemented):
      availableEntries.append(entry.SymbolicValue())
 
# Set BalanceWhiteAuto to "Off" (str)
nodeMapRemoteDevice.FindNode("BalanceWhiteAuto").SetCurrentEntry("Off")