IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.
Defines the auto function to be calculated based on the sub-region, e.g. ExposureAuto and GainAuto.
Name |
SubRegionSelector |
Category |
|
Interface |
Enumeration |
Access |
Read/Write |
Unit |
- |
Visibility |
Expert |
Values |
AutoFeatureBrightnessAuto AutoFeatureBalanceWhiteAuto AutoFeatureFocusAuto |
Standard |
IDS |
Availability uEye+ |
|
Availability uEye |
- |
Values description
•AutoFeatureBrightnessAuto: The image information from the sub-region is used for ExposureAuto and GainAuto.
•AutoFeatureBalanceWhiteAuto: The image information from the sub-region is used for BalanceWhiteAuto.
•AutoFeatureFocusAuto: The image information from the sub-region is used for FocusAuto.
Code example
C++
// Determine the current entry of SubRegionSelector
std::string value = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("SubRegionSelector")->CurrentEntry()->SymbolicValue();
// Get a list of all available entries of SubRegionSelector
auto allEntries = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("SubRegionSelector")->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 SubRegionSelector to "AutoFeatureBrightnessAuto"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("SubRegionSelector")->SetCurrentEntry("AutoFeatureBrightnessAuto");
C#
// Determine the current entry of SubRegionSelector
string value = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("SubRegionSelector").CurrentEntry().SymbolicValue();
// Get a list of all available entries of SubRegionSelector
allEntries = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("SubRegionSelector").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 SubRegionSelector to "AutoFeatureBrightnessAuto"
nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("SubRegionSelector").SetCurrentEntry("AutoFeatureBrightnessAuto");
Python
# Determine the current entry of SubRegionSelector (str)
value = nodeMapRemoteDevice.FindNode("SubRegionSelector").CurrentEntry().SymbolicValue()
# Get a list of all available entries of SubRegionSelector
allEntries = nodeMapRemoteDevice.FindNode("SubRegionSelector").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 SubRegionSelector to "AutoFeatureBrightnessAuto" (str)
nodeMapRemoteDevice.FindNode("SubRegionSelector").SetCurrentEntry("AutoFeatureBrightnessAuto")