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.

This function combines pixels horizontally. This reduces the horizontal resolution (width) of the image by the specified horizontal binning factor. The mode which is used to combine the pixels is specified in BinningHorizontalMode.

hint_info

Note that for some camera models BinningHorizontal can only be set along with BinningVertical.

With some camera models, the vertical height is restricted during binning.

Name

BinningHorizontal[BinningSelector]

Category

ImageFormatControl

Interface

Integer

Access

Read/Write

Unit

-

Visibility

Expert

Values

sensor specific

Standard

SFNC

Availability uEye+

icon-gev icon-u3v

Availability uEye

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

Values description

Number of horizontal photo-sensitive cells to combine together. A value of 1 indicates that horizontal binning is not enabled.

hint_info

This feature is not available with the SensorOperationMode "Linescan".

hint_info

Can only be changed if SequencerMode is "Off".

hint_info

The access changes to read-only during an acquisition.

hint_info

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 BinningHorizontal, make sure BinningSelector is set correctly
// Set BinningSelector to "Region0"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("BinningSelector")->SetCurrentEntry("Region0");
// Determine the current BinningHorizontal
int64_t value = nodeMapRemoteDevice->FindNode<peak::core::nodes::IntegerNode>("BinningHorizontal")->Value();
// Set BinningHorizontal to 1
nodeMapRemoteDevice->FindNode<peak::core::nodes::IntegerNode>("BinningHorizontal")->SetValue(1);

C#

// Before accessing BinningHorizontal, make sure BinningSelector is set correctly
// Set BinningSelector to "Region0"
nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("BinningSelector").SetCurrentEntry("Region0");
// Determine the current BinningHorizontal
long value = nodeMapRemoteDevice.FindNode<peak.core.nodes.IntegerNode>("BinningHorizontal").Value();
// Set BinningHorizontal to 1
nodeMapRemoteDevice.FindNode<peak.core.nodes.IntegerNode>("BinningHorizontal").SetValue(1);

Python

# Before accessing BinningHorizontal, make sure BinningSelector is set correctly
# Set BinningSelector to "Region0" (str)
nodeMapRemoteDevice.FindNode("BinningSelector").SetCurrentEntry("Region0")
# Determine the current BinningHorizontal (int)
value = nodeMapRemoteDevice.FindNode("BinningHorizontal").Value()
# Set BinningHorizontal to 1 (int)
nodeMapRemoteDevice.FindNode("BinningHorizontal").SetValue(1)

© 2024 IDS Imaging Development Systems GmbH