DecimationY

Description

Returns or sets the vertical subsampling of the image.


Syntax

[VB]
objActiveGige.DecimationY [= Value]

[C/C++]
HRESULT get_DecimationY( long *pDecimationY );
HRESULT put_DecimationY( long DecimationY );


Data Type [VB]

Long


Parameters [C/C++]

pDecimationY [out,retval]

Pointer to the currently set vertical binning

DecimationY [in]

The vertical decimation to be set

Return Values

S_OK

Success

E_FAIL

Failure.

E_INVALIDARG

Invalid property value.

Example

This VB example sets the vertical decimation to 2:

ActiveGige1.DecimationY = 2
MsgBox ActiveGige1.DecimationY

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 vertical size of the image by the specified decimation factor. A value of 1 indicates that no vertical decimation is performed by the camera. Note that the property is available only if the currently selected camera supports the Decimationvertical feature per GenICam standard. Any change in the DecimationY property will cause SizeY, and OffsetY to change accordingly.