Home > C: Programming > Function Descriptions > | History back Previous chapter Next chapter Print |
is_SetSubSampling |
uEye Camera Manual Version 3.80
is_SetSubSampling
USB 2.0 GigE |
USB 2.0 GigE |
Syntax
INT is_SetSubSampling (HIDS hCam, INT mode)
Description
Using is_SetSubSampling(), you can enable sub-sampling mode both in horizontal and in vertical directions. This allows you to reduce the image size in the sub-sampling direction without scaling down the area of interest. In order to simultaneously enable horizontal and vertical sub-sampling, the horizontal and vertical sub-sampling parameters can by linked by a logical OR.
Some monochrome sensors are limited by their design to mere color sub-sampling. In case of fine image structures, this can result in slight artifacts.
The adjustable sub-sampling factors of each sensor are listed in Camera and Sensor Data chapter.
|
|
Input Parameters
hCam |
Camera handle |
mode |
|
IS_SUBSAMPLING_DISABLE |
Disables sub-sampling. |
IS_SUBSAMPLING_2X_VERTICAL |
Enables vertical sub-sampling with factor 2. |
IS_SUBSAMPLING_3X_VERTICAL |
Enables vertical sub-sampling with factor 3. |
IS_SUBSAMPLING_4X_VERTICAL |
Enables vertical sub-sampling with factor 4. |
IS_SUBSAMPLING_5X_VERTICAL |
Enables vertical sub-sampling with factor 5. |
IS_SUBSAMPLING_6X_VERTICAL |
Enables vertical sub-sampling with factor 6. |
IS_SUBSAMPLING_8X_VERTICAL |
Enables vertical sub-sampling with factor 8. |
IS_SUBSAMPLING_16X_VERTICAL |
Enables vertical sub-sampling with factor 16. |
IS_SUBSAMPLING_2X_HORIZONTAL |
Enables horizontal sub-sampling with factor 2. |
IS_SUBSAMPLING_3X_HORIZONTAL |
Enables horizontal sub-sampling with factor 3. |
IS_SUBSAMPLING_4X_HORIZONTAL |
Enables horizontal sub-sampling with factor 4. |
IS_SUBSAMPLING_5X_HORIZONTAL |
Enables horizontal sub-sampling with factor 5. |
IS_SUBSAMPLING_6X_HORIZONTAL |
Enables horizontal sub-sampling with factor 6. |
IS_SUBSAMPLING_8X_HORIZONTAL |
Enables horizontal sub-sampling with factor 8. |
IS_SUBSAMPLING_16X_HORIZONTAL |
Enables horizontal sub-sampling with factor 16. |
IS_GET_SUBSAMPLING |
Returns the current setting. |
IS_GET_SUBSAMPLING_FACTOR_VERTICAL |
Returns the vertical sub-sampling factor |
IS_GET_SUBSAMPLING_FACTOR_HORIZONTAL |
Returns the horizontal sub-sampling factor |
IS_GET_SUBSAMPLING_TYPE |
Indicates whether the camera uses color-proof sub-sampling. |
IS_GET_SUPPORTED_SUBSAMPLING |
Returns the supported sub-sampling modes. |
Return Values
IS_SUCCESS |
Function executed successfully |
IS_NO_SUCCESS |
General error message |
Current setting when used together with |
Returns IS_SUBSAMPLING_COLOR if the camera uses color-proof sub-sampling, else IS_SUBSAMPLING_MONO |
When used with |
Returns the supported sub-sampling modes linked by logical ORs |
Related Functions