BinningY
Top  Previous  Next

Description

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


Syntax


[VB]
objActiveUSB.BinningY [= Value]


[C/C++]
HRESULT get_BinningY( long *pBinningY );
HRESULT put_BinningY( long BinningY );



Data Type
[VB]

Long


Parameters
[C/C++]

pBinningY [out,retval]  
Pointer to the currently set vertical binning  
BinningY [in]  
The vertical binning to be set  


Return Values


S_OK  
Success  
E_FAIL  
Failure.  
E_INVALIDARG  
Invalid property value.  
 

Example


This VB example sets the vertical binning to 2:

ActiveUSB1.BinningY = 2
MsgBox ActiveUSB1.BinningY
 

Remarks


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