IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.
GainSelector
There are several gain values that differ by type (analog, digital, combined) and channel (master, red, green, blue).
GainSelector entry (generic) |
Gain type (comfort) |
Gain channel (comfort) |
Meaning |
---|---|---|---|
AnalogAll |
PEAK_GAIN_TYPE_ANALOG |
PEAK_GAIN_CHANNEL_MASTER |
Analog master gain to all channels. Done by the sensor before digitization. |
AnalogRed, AnalogGreen, AnalogBlue |
PEAK_GAIN_TYPE_ANALOG |
PEAK_GAIN_CHANNEL_RED, PEAK_GAIN_CHANNEL_GREEN, PEAK_GAIN_CHANNEL_BLUE |
Analog gain for color gains. Done by the sensor before digitization (if available). |
DigitalAll |
PEAK_GAIN_TYPE_DIGITAL |
PEAK_GAIN_CHANNEL_MASTER |
Digital master gain to all channels. Usually done in FPGA for IDS Vision cameras. |
DigitalRed, DigitalGreen, DigitalBlue |
PEAK_GAIN_TYPE_DIGITAL |
PEAK_GAIN_CHANNEL_RED, PEAK_GAIN_CHANNEL_GREEN, PEAK_GAIN_CHANNEL_BLUE |
Digital gain for color gains. Usually done in FPGA for uEye+ cameras. |
All |
PEAK_GAIN_TYPE_COMBINED |
PEAK_GAIN_CHANNEL_MASTER |
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, Green, Blue |
PEAK_GAIN_TYPE_COMBINED |
PEAK_GAIN_CHANNEL_RED, PEAK_GAIN_CHANNEL_GREEN, PEAK_GAIN_CHANNEL_BLUE |
See above. Non-unique selector for the color gains. |
With comfortSDK, the information about gain type and gain channel is passed with each function call.
comfortC |
---|
peak_status status = PEAK_STATUS_SUCCESS; |
With genericSDK, the GainSelector must first be set before the associated gain value can be read or written. After setting the GainSelector, all functions are applied to this gain.
genericC++ |
---|
// Get current GainSelector entry |
Querying the minimum value, maximum value and increment
comfortC |
---|
peak_status status = PEAK_STATUS_SUCCESS; |
genericC++ |
---|
// Set GainSelector to "DigitalRed"; |
Querying the current gain value
comfortC |
---|
peak_status status = PEAK_STATUS_SUCCESS; |
genericC++ |
---|
double gain = nodemapRemoteDevice->FindNode<peak::core::nodes::FloatNode>("Gain")->Value(); |
Setting the gain value
comfortC |
---|
peak_status status = PEAK_STATUS_SUCCESS; |
genericC++ |
---|
double gain = 1.5; |
Querying the range for the color gains, the current value and setting a new, valid value
Prerequisite: The IDS peak API and a camera was opened (Device). See also Opening a camera (API)