IDS Peak comfortSDK, genericSDK, AFL, ICL, and IPL developer manuals are external documents.
Please contact us if you need these manuals.
Returns the status of the automatic white balance (BalanceWhiteAuto).
Name |
BalanceWhiteAutoStatus |
Category |
|
Interface |
Enumeration |
Access |
Read |
Unit |
- |
Visibility |
Expert |
Values |
Active Done Off |
Standard |
IDS |
Availability uEye+ |
|
Availability uEye |
- |
Values description
•Active: Automatic white balance is adjusting to reach the requested white value.
•Done: Automatic white balance reached the requested white value.
•Off: Automatic white balance is disabled.
Code example
C++
// Determine the current entry of BalanceWhiteAutoStatus
std::string value = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("BalanceWhiteAutoStatus")->CurrentEntry()->SymbolicValue();
// Get a list of all available entries of BalanceWhiteAutoStatus
auto allEntries = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("BalanceWhiteAutoStatus")->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);
}
}
C#
// Determine the current entry of BalanceWhiteAutoStatus
string value = nodeMapRemoteDevice.FindNode<IDSImaging.Peak.API.Core.Nodes.EnumerationNode>("BalanceWhiteAutoStatus").CurrentEntry().SymbolicValue();
// Get a list of all available entries of BalanceWhiteAutoStatus
allEntries = nodeMapRemoteDevice.FindNode<IDSImaging.Peak.API.Core.Nodes.EnumerationNode>("BalanceWhiteAutoStatus").Entries();
List<string> availableEntries = new List<string>();
for(int i = 0; i < allEntries.Count(); ++i)
{
if ((allEntries[i].AccessStatus() != IDSImaging.Peak.API.Core.Nodes.NodeAccessStatus.NotAvailable)
&& (allEntries[i].AccessStatus() != IDSImaging.Peak.API.Core.Nodes.NodeAccessStatus.NotImplemented))
{
availableEntries.Add(allEntries[i].SymbolicValue());
}
}
Python
# Determine the current entry of BalanceWhiteAutoStatus (str)
value = nodeMapRemoteDevice.FindNode("BalanceWhiteAutoStatus").CurrentEntry().SymbolicValue()
# Get a list of all available entries of BalanceWhiteAutoStatus
allEntries = nodeMapRemoteDevice.FindNode("BalanceWhiteAutoStatus").Entries()
availableEntries = []
for entry in allEntries:
if (entry.AccessStatus() != ids_peak.NodeAccessStatus_NotAvailable
and entry.AccessStatus() != ids_peak.NodeAccessStatus_NotImplemented):
availableEntries.append(entry.SymbolicValue())