IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.
Enables or disables the limits for BrightnessAutoGainMin and BrightnessAutoGainMax. When GainAuto is active, the gain can vary within these limits.
Name |
BrightnessAutoGainLimitMode |
Category |
|
Interface |
Enumeration |
Access |
Read/Write |
Unit |
- |
Visibility |
Expert |
Values |
Off |
Standard |
IDS |
Availability uEye+ |
|
Availability uEye |
- |
Values description
•Off: Disables BrightnessAutoGainMin and BrightnessAutoGainMax.
The range of gain is only limited by sensor properties.
•On: Enables BrightnessAutoGainMin and BrightnessAutoGainMax.
The range of gain is limited by BrightnessAutoGainMin and BrightnessAutoGainMax.
Code example
C++
// Determine the current entry of BrightnessAutoGainLimitMode
std::string value = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("BrightnessAutoGainLimitMode")->CurrentEntry()->SymbolicValue();
// Get a list of all available entries of BrightnessAutoGainLimitMode
auto allEntries = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("BrightnessAutoGainLimitMode")->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 BrightnessAutoGainLimitMode to "On"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("BrightnessAutoGainLimitMode")->SetCurrentEntry("On");
C#
// Determine the current entry of BrightnessAutoGainLimitMode
string value = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("BrightnessAutoGainLimitMode").CurrentEntry().SymbolicValue();
// Get a list of all available entries of BrightnessAutoGainLimitMode
allEntries = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("BrightnessAutoGainLimitMode").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 BrightnessAutoGainLimitMode to "On"
nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("BrightnessAutoGainLimitMode").SetCurrentEntry("On");
Python
# Determine the current entry of BrightnessAutoGainLimitMode (str)
value = nodeMapRemoteDevice.FindNode("BrightnessAutoGainLimitMode").CurrentEntry().SymbolicValue()
# Get a list of all available entries of BrightnessAutoGainLimitMode
allEntries = nodeMapRemoteDevice.FindNode("BrightnessAutoGainLimitMode").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 BrightnessAutoGainLimitMode to "On" (str)
nodeMapRemoteDevice.FindNode("BrightnessAutoGainLimitMode").SetCurrentEntry("On")