SetBinning

Syntax

LONG SetBinning (LONG lMode)

Description

With SetBinning() you can enable the binning mode both in horizontal and in vertical direction. This way, the image size in the binning direction can be reduced without scaling down the area of interest. Depending on the sensor used, the sensitivity or the frame rate can be increased while binning is enabled.

To enable horizontal and vertical binning at the same time, you can link the horizontal and vertical binning parameters by a logical OR.

The adjustable binning factors of each sensor are listed in the "Specifications: Sensors" chapter in the uEye Manual.

Hinweis

Some sensors allow a higher pixel clock setting if binning or subsampling has been activated. If you set a higher pixel clock and then reduce the binning/subsampling factors again, the driver will automatically select the highest possible pixel clock for the new settings.

Achtung

Changes to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time. After executing SetBinning(), calling the following functions is recommended in order to keep the defined camera settings:

•SetFrameRate()

•SetExposureTime()

•If you are using the uEye's flash function: SetFlashStrobe()

Parameters

lMode
IS_BINNING_DISABLE	Disables binning.
IS_BINNING_2X_VERTICAL	Enables vertical binning with factor 2.
IS_BINNING_3X_VERTICAL	Enables vertical binning with factor 3.
IS_BINNING_4X_VERTICAL	Enables vertical binning with factor 4.
IS_BINNING_6X_VERTICAL	Enables vertical binning with factor 6.
IS_BINNING_2X_HORIZONTAL	Enables horizontal binning with factor 2.
IS_BINNING_3X_HORIZONTAL	Enables horizontal binning with factor 3.
IS_BINNING_4X_HORIZONTAL	Enables horizontal binning with factor 4.
IS_BINNING_6X_HORIZONTAL	Enables horizontal binning with factor 6.

Return values

IS_SUCCESS	Function executed successfully
IS_NO_SUCCESS	General error message

Related functions

•GetBinning()

•SetAOI()

•SetSubSampling()

Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!

For technical questions please contact you local distributor or use the support form on our website.

Home > Function descriptions >	History back Previous chapter Next chapter Print
SetBinning