Is_Setsubsampling - THORLABS DCU223x Operation Manual And Sdk

4.3.95 is_SetSubSampling

USB 2.0
USB 3.0
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
Note
Some sensors allow a higher pixel clock setting when binning or subsampling is activated. If you set a higher pixel
clock and then reduce the binning/subsampling factors again, the driver will automatically select the highest
possible pixel clock for the new settings.
Attention
Changes to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time. After
executing is_SetSubSampling(), calling the following functions is recommended in order to keep the defined
camera settings:
is_SetFrameRate()
is_Exposure()
216
If you are using the DCx Camera's flash function:
Input parameters
hCam
mode
IS_SUBSAMPLING_DISABLE
IS_SUBSAMPLING_2X_VERTICAL
IS_SUBSAMPLING_3X_VERTICAL
IS_SUBSAMPLING_4X_VERTICAL
IS_SUBSAMPLING_5X_VERTICAL
IS_SUBSAMPLING_6X_VERTICAL
IS_SUBSAMPLING_8X_VERTICAL
IS_SUBSAMPLING_16X_VERTICAL
IS_SUBSAMPLING_2X_HORIZONTAL
IS_SUBSAMPLING_3X_HORIZONTAL
IS_SUBSAMPLING_4X_HORIZONTAL
IS_SUBSAMPLING_5X_HORIZONTAL
IS_SUBSAMPLING_6X_HORIZONTAL
IS_SUBSAMPLING_8X_HORIZONTAL
IS_SUBSAMPLING_16X_HORIZONTAL
IS_GET_SUBSAMPLING
IS_GET_SUBSAMPLING_FACTOR_VERTICAL
© 2013 Thorlabs GmbH
USB 2.0
USB 3.0
329
Camera and sensor data
is_IO()
280
Camera handle
Disables sub-sampling.
Enables vertical sub-sampling with factor 2.
Enables vertical sub-sampling with factor 3.
Enables vertical sub-sampling with factor 4.
Enables vertical sub-sampling with factor 5.
Enables vertical sub-sampling with factor 6.
Enables vertical sub-sampling with factor 8.
Enables vertical sub-sampling with factor 16.
Enables horizontal sub-sampling with factor 2.
Enables horizontal sub-sampling with factor 3.
Enables horizontal sub-sampling with factor 4.
Enables horizontal sub-sampling with factor 5.
Enables horizontal sub-sampling with factor 6.
Enables horizontal sub-sampling with factor 8.
Enables horizontal sub-sampling with factor 16.
Returns the current setting.
Returns the vertical sub-sampling factor
4 Programming (SDK)
chapter.
460
347