BinningX

Description

Returns or sets the number of horizontal photo-sensitive cells that must be combined together.


Syntax

[VB]
objActiveGige.BinningX [= Value]

[C/C++]
HRESULT get_BinningX( long *pBinningX );
HRESULT put_BinningX( long BinningX );


Data Type [VB]

Long


Parameters [C/C++]

pBinningX [out,retval]

Pointer to the currently set horizontal binning

BinningX [in]

The horizontal binning to be set

Return Values

S_OK

Success

E_FAIL

Failure.

E_INVALIDARG

Invalid property value.

Example

This VB example sets the horizontal binning to 2:

ActiveGige1.BinningX = 2
MsgBox ActiveGige1.BinningX

Remarks

This property has a net effect of increasing the intensity (or signal to noise ratio) of the pixel value and reducing the horizontal size of the image. A value of 1 indicates that no horizontal binning is performed by the camera. Note that the property is available only if the currently selected camera supports the BinningHorizontal feature per GenICam standard. Any change in the BinningX property will cause SizeX, and OffsetX to change accordingly.