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.

Binning and Decimation are two methods to downsample the image, typically before it is sent out by the camera. See Binning and Decimation.

Most camera models support binning and decimation on the FPGA. Some sensors also support binning or decimation as sensor feature. You can switch between sensor and FPGA feature through BinningSelector and DecimationSelector respectively.

•"Sensor": controls sensor binning or decimation.

•"Region0": controls FPGA binning.

You can combine sensor and FPGA features. You cannot combine the two FPGA features (FPGA binning with FPGA decimation).

The FPGA features typically do not increase frame rate. But since the downsampling reduces the data rate, the maximum frame rate, that can be transferred, can be increased.

Configuration: FPGA binning

Set BinningSelector to "Region0" and activate binning by choosing a binning factor > 1. Use the same binning factors in vertical and horizontal direction to avoid distorted images. FPGA binning typically supports binning factors up to 8.

BinningSelector = Region0;
BinningHorizontal = 2;
BinningVertical = 2;

You can read the binning method for each direction (BinningHorizontalMode, BinningVerticalMode). Typically the entry is "Sum" for FPGA binning.

BinningSelector = Sensor;
myHorizontalBinningMethod = BinningHorizontalMode.Entry;
myVerticalBinningMethod = BinningVerticalMode.Entry;

Configuration: FPGA decimation

Set DecimationSelector to "Region0" and activate decimation by choosing a decimation factor > 1. Use the same decimation factors in vertical and horizontal direction to avoid distorted images. FPGA decimation typically supports decimation factors up to 8.

DecimationSelector = Region0;
DecimationHorizontal = 2;
DecimationVertical = 2;

Configuration: Sensor binning

Set BinningSelector to "Sensor" and activate binning by choosing a binning factor > 1. Use the same binning factors in vertical and horizontal direction to avoid distorted images.

BinningSelector = Sensor;
BinningHorizontal = 2;
BinningVertical = 2;

You can read the binning method for each direction (BinningHorizontalMode, BinningVerticalMode). Typically the entry is "Average" or "Sum".

BinningSelector = Sensor;
myHorizontalBinningMethod = BinningHorizontalMode.Entry;
myVerticalBinningMethod = BinningVerticalMode.Entry;

Configuration: Sensor decimation

Set DecimationSelector to "Sensor" and activate decimation by choosing a decimation factor > 1. Use the same decimation factors in vertical and horizontal direction to avoid distorted images.

DecimationSelector = Sensor;
DecimationHorizontal = 2;
DecimationVertical = 2;

Dependencies to other features: ROI: Width, Height, OffsetX, OffsetY

When you activate and deactivate binning or decimation, your ROI parameters (Width, Height, OffsetX, OffsetY) are adapted to the new settings. Due to increment requirements, this can lead to slightly different ROIs, also if you deactivate binning or decimation again.

Example: A ROI is set with an OffsetX of 40 px. When activating 2x horizontal sensor binning, the theoretical new value would be 20 px, which cannot be divided by the 8 px increment of OffsetX. Instead, OffsetX changes to 24 px. When de-activating binning again, OffsetX is doubled to 48 px.

Dependencies to other features: Brightness: ExposureTime and Gain

Additive binning ("Sum") increases the image brightness (grey values). Thus, ExposureTime and Gain must be adjusted after activating or de-activating this feature.

Additional information