Please enable JavaScript to view this site.

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.

Selects the gain to be configured.

hint_info

The gains supported by a camera depend on the sensor and may differ. Typically, color cameras either support digital or analog color gains.

Name

GainSelector

Category

AnalogControl

Interface

Enumeration

Access

Read/Write

Unit

-

Visibility

Beginner

Values

AnalogAll

AnalogRed

AnalogGreen

AnalogBlue

DigitalAll

DigitalRed

DigitalGreen

DigitalBlue

All

Red

Green

Blue

Standard

SFNC

Availability uEye+

icon-gev icon-u3v

Availability uEye

icon-ui-gige icon-ui-usb2 icon-ui-usb3

Values description

AnalogAll: Gain will be applied to all analog channels. This feature is only supported by uEye+ cameras (GV and U3 models).

AnalogRed: Gain will be applied to the red analog channel. This feature is only supported by uEye+ cameras (GV and U3 models).

AnalogGreen: Gain will be applied to the green analog channel. This feature is only supported by uEye+ cameras (GV and U3 models).

AnalogBlue: Gain will be applied to the blue analog channel. This feature is only supported by uEye+ cameras (GV and U3 models).

DigitalAll: Gain will be applied to all digital channels. This feature is only supported by uEye+ cameras (GV and U3 models).

DigitalRed: Gain will be applied to the red digital channel. This feature is only supported by uEye+ cameras (GV and U3 models).

DigitalGreen: Gain will be applied to the green digital channel. This feature is only supported by uEye+ cameras (GV and U3 models).

DigitalBlue: Gain will be applied to the blue digital channel. This feature is only supported by uEye+ cameras (GV and U3 models).

All: Master gain to all channels, but depending on the camera model, how this is done. In case of support for uEye cameras by the uEye Transport Layer, the gains may be achieved by combining analog and digital gain.

Red: Red gain, but depending on the camera model, how this is done. In case of support for uEye cameras by the uEye Transport Layer, the gains may be achieved by combining analog and digital gain. This feature is only supported by uEye cameras (UI models).

Green: Green gain, but depending on the camera model, how this is done. In case of support for uEye cameras by the uEye Transport Layer, the gains may be achieved by combining analog and digital gain. This feature is only supported by uEye cameras (UI models).

Blue: Blue gain, but depending on the camera model, how this is done. In case of support for uEye cameras by the uEye Transport Layer, the gains may be achieved by combining analog and digital gain. This feature is only supported by uEye cameras (UI models).

Code example

C++

// Determine the current entry of GainSelector
std::string value = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("GainSelector")->CurrentEntry()->SymbolicValue();
// Get a list of all available entries of GainSelector
auto allEntries = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("GainSelector")->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 GainSelector to "AnalogAll"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("GainSelector")->SetCurrentEntry("AnalogAll");

C#

// Determine the current entry of GainSelector
string value = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("GainSelector").CurrentEntry().SymbolicValue();
// Get a list of all available entries of GainSelector
allEntries = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("GainSelector").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 GainSelector to "AnalogAll"
nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("GainSelector").SetCurrentEntry("AnalogAll");

Python

# Determine the current entry of GainSelector (str)
value = nodeMapRemoteDevice.FindNode("GainSelector").CurrentEntry().SymbolicValue()
# Get a list of all available entries of GainSelector
allEntries = nodeMapRemoteDevice.FindNode("GainSelector").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 GainSelector to "AnalogAll" (str)
nodeMapRemoteDevice.FindNode("GainSelector").SetCurrentEntry("AnalogAll")

© 2024 IDS Imaging Development Systems GmbH