DecimationX
Top  Previous  Next

Description

Returns or sets the horizontal subsampling of the image.


Syntax


[VB]
objActiveGeni.DecimationX [= Value]


[C/C++]
HRESULT get_DecimationX( long *pDecimationX );
HRESULT put_DecimationX( long DecimationX );



Data Type
[VB]

Long


Parameters
[C/C++]

pDecimationX [out,retval]  
Pointer to the currently set horizontal binning  
DecimationX [in]  
The horizontal decimation to be set  


Return Values


S_OK  
Success  
E_FAIL  
Failure.  
E_INVALIDARG  
Invalid property value.  
 

Example


This VB example sets the horizontal decimation to 2:

ActiveGeni1.DecimationX = 2
MsgBox ActiveGeni1.DecimationX
 

Remarks


Depending on the camera, the subsampling can be implemented by pixel dropping or by pixel averaging/dropping. This has a net effect of reducing the horizontal size of the image by the specified decimation factor. A value of 1 indicates that no horizontal decimation is performed by the camera. Note that the property is available only if the currently selected camera supports the DecimationHorizontal feature per GenICam standard. Any change in the DecimationX property will cause SizeX, and OffsetX to change accordingly.