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.
This function combines pixels vertically. This reduces the vertical resolution (height) of the image by the specified vertical binning factor. The mode which is used to combine the pixels is specified in BinningVerticalMode.
|
Note that for some camera models BinningVertical can only be set along with BinningHorizontal. With some camera models, the vertical height is restricted during binning. |
Name |
BinningVertical[BinningSelector] |
Category |
|
Interface |
Integer |
Access |
Read/Write |
Unit |
- |
Visibility |
Expert |
Values |
sensor specific |
Standard |
SFNC |
Availability uEye+ |
|
Availability uEye |
|
Values description
•Number of vertical photo-sensitive cells to combine together. A value of 1 indicates that vertical binning is not enabled.
|
This feature is not available with the SensorOperationMode "Linescan". |
|
Can only be changed if SequencerMode is "Off". |
|
The access changes to read-only during an acquisition. |
|
Note for uEye cameras (UI models) •Binning cannot be changed if image acquisition is enabled. •You cannot use binning and decimation at the same time. If you enable DecimationHorizontal or DecimationVertical, BinningHorizontal and BinningVertical are reset to "1". •If you use binning with hot pixel correction, check the settings of HotpixelCorrectionMode after enabling binning. |
Code example
C++
// Before accessing BinningVertical, make sure BinningSelector is set correctly
// Set BinningSelector to "Region0"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("BinningSelector")->SetCurrentEntry("Region0");
// Determine the current BinningVertical
int64_t value = nodeMapRemoteDevice->FindNode<peak::core::nodes::IntegerNode>("BinningVertical")->Value();
// Set BinningVertical to 1
nodeMapRemoteDevice->FindNode<peak::core::nodes::IntegerNode>("BinningVertical")->SetValue(1);
C#
// Before accessing BinningVertical, make sure BinningSelector is set correctly
// Set BinningSelector to "Region0"
nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("BinningSelector").SetCurrentEntry("Region0");
// Determine the current BinningVertical
long value = nodeMapRemoteDevice.FindNode<peak.core.nodes.IntegerNode>("BinningVertical").Value();
// Set BinningVertical to 1
nodeMapRemoteDevice.FindNode<peak.core.nodes.IntegerNode>("BinningVertical").SetValue(1);
Python
# Before accessing BinningVertical, make sure BinningSelector is set correctly
# Set BinningSelector to "Region0" (str)
nodeMapRemoteDevice.FindNode("BinningSelector").SetCurrentEntry("Region0")
# Determine the current BinningVertical (int)
value = nodeMapRemoteDevice.FindNode("BinningVertical").Value()
# Set BinningVertical to 1 (int)
nodeMapRemoteDevice.FindNode("BinningVertical").SetValue(1)
