IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.
Controls if the color correction is active. If color correction is active, the ColorCorrectionMatrix is used to enhance color rendering.
uEye cameras: The value of ColorCorrectionMode cannot be changed. |
Name |
ColorCorrectionMode |
Category |
|
Interface |
Enumeration |
Access |
Read/Write |
Unit |
- |
Visibility |
Beginner |
Values |
Off Auto |
Standard |
IDS |
Availability uEye+ |
|
Availability uEye |
|
Values description
•Off: Disables color correction.
•Auto: Enables color correction automatically, if the selected PixelFormat is a debayered color format. This feature is only supported by uEye+ cameras (GV and U3 models).
Code example
C++
// ColorCorrectionMode refers to the entry selected by ColorCorrectionMatrix
// Set ColorCorrectionMatrix to "HQ"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("ColorCorrectionMatrix")->SetCurrentEntry("HQ");
// Determine the current entry of ColorCorrectionMode
std::string value = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("ColorCorrectionMode")->CurrentEntry()->SymbolicValue();
// Get a list of all available entries of ColorCorrectionMode
auto allEntries = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("ColorCorrectionMode")->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 ColorCorrectionMode to "Auto"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("ColorCorrectionMode")->SetCurrentEntry("Auto");
C#
// ColorCorrectionMode refers to the entry selected by ColorCorrectionMatrix
// Set ColorCorrectionMatrix to "HQ"
nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("ColorCorrectionMatrix").SetCurrentEntry("HQ");
// Determine the current entry of ColorCorrectionMode
string value = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("ColorCorrectionMode").CurrentEntry().SymbolicValue();
// Get a list of all available entries of ColorCorrectionMode
allEntries = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("ColorCorrectionMode").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 ColorCorrectionMode to "Auto"
nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("ColorCorrectionMode").SetCurrentEntry("Auto");
Python
# ColorCorrectionMode refers to the entry selected by ColorCorrectionMatrix
# Set ColorCorrectionMatrix to "HQ" (str)
nodeMapRemoteDevice.FindNode("ColorCorrectionMatrix").SetCurrentEntry("HQ")
# Determine the current entry of ColorCorrectionMode (str)
value = nodeMapRemoteDevice.FindNode("ColorCorrectionMode").CurrentEntry().SymbolicValue()
# Get a list of all available entries of ColorCorrectionMode
allEntries = nodeMapRemoteDevice.FindNode("ColorCorrectionMode").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 ColorCorrectionMode to "Auto" (str)
nodeMapRemoteDevice.FindNode("ColorCorrectionMode").SetCurrentEntry("Auto")