Home > C: Programming > Function Descriptions > History back  Previous chapter  Next chapter  Print  

is_SetBinning

uEye Camera Manual Version 3.80

is_SetBinning

Windows_Logo

Linux_Logo

USB 2.0

GigE

USB 2.0

GigE

Syntax

INT is_SetBinning (HIDS hCam, INT mode)

Description

Using is_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 Camera and Sensor Data chapter.

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 is_SetBinning(), calling the following functions is recommended in order to keep the defined camera settings:

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

Achtung

Note on camera models UI-1240/UI-5240 and UI-1550/UI-5550

For the models UI-1240/UI-5240 and UI-1550/UI-5550, you can use Binning only combined for the horizontal and the vertical direction. Please see also the information in chapters UI-124x / UI-524x Application Notes and UI-155x / UI-555x Application Notes.

Input Parameters

hCam

Camera handle

mode


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.

IS_GET_BINNING

Returns the current setting.

IS_GET_BINNING_FACTOR
_VERTICAL

Returns the vertical binning factor.

IS_GET_BINNING_FACTOR
_HORIZONTAL

Returns the horizontal binning factor.

IS_GET_SUPPORTED_BINNING

Returns the supported binning modes.

IS_GET_BINNING_TYPE

Indicates whether the camera uses color-proof binning (IS_BINNING_COLOR) or not.
(IS_BINNING_MONO)

Return Values

IS_SUCCESS

Function executed successfully

IS_NO_SUCCESS

General error message

Current setting when used together with

IS_GET_BINNING

IS_GET_BINNING_FACTOR_VERTICAL

IS_GET_BINNING_FACTOR_HORIZONTAL


When used with

IS_GET_BINNING_TYPE

Returns IS_BINNING_COLOR if the camera uses color-proof binning; otherwise, IS_BINNING_MONO is returned.

When used with

IS_GET_SUPPORTED_BINNING

Returns the supported binning modes linked by logical ORs.

Related Functions

is_SetSubSampling()
is_SetAOI()
is_SetImagePos()
is_SetPixelClock()

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


© 2010 IDS Imaging Development Systems GmbH
http://www.ids-imaging.com