Please enable JavaScript to view this site.

IDS Software Suite 4.96.1

Windows_Logo
Linux_Logo

USB 2.0

USB 3.x

GigE

USB 2.0

USB 3.x

GigE

Syntax

INT is_SetSubSampling (HIDS hCam, INT mode)

Description

Using is_SetSubSampling(), you can enable subsampling mode both in horizontal and in vertical directions. This allows you to reduce the image size in the subsampling direction without scaling down the area of interest. In order to simultaneously enable horizontal and vertical subsampling, the horizontal and vertical subsampling parameters can by linked by a logical OR.

hint_info

Note that binning or subsampling cannot be activated if the AOI size is set to the minimum value.

Some monochrome sensors are limited by their design to mere color subsampling. In case of fine image structures, this can result in slight artifacts.

The adjustable subsampling factors of each sensor are listed in Camera and sensor data chapter.

Some sensors allow a higher pixel clock setting if binning or subsampling has been 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.

hint_info

This function is currently not supported by the following camera models:

UI-1007XS

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()

If you are using the uEye camera's flash function: is_IO()

Input parameters

hCam

Camera handle

Return values

When used with

IS_GET_SUBSAMPLING

Current setting: Returns the defined constants using "OR" from ueye.h, e.g. IS_SUBSAMPLING_2X_HORIZONTAL

When used with

IS_GET_SUBSAMPLING_FACTOR_VERTICAL

IS_GET_SUBSAMPLING_FACTOR_HORIZONTAL

Current setting: Returns the current factor as integer value (2, 3, 4, 5, 6, 8, 16)

When used with

IS_GET_SUBSAMPLING_TYPE

Current setting: Returns IS_SUBSAMPLING_COLOR if the camera uses color-proof subsampling, else IS_SUBSAMPLING_MONO

When used with

IS_GET_SUPPORTED_SUBSAMPLING

Returns the supported subsampling modes linked by logical ORs

IS_BAD_STRUCTURE_SIZE

An internal structure has an incorrect size.

IS_CANT_ADD_TO_SEQUENCE

The image memory is already included in the sequence and cannot be added again.

IS_CANT_COMMUNICATE_WITH_DRIVER

Communication with the driver failed because no driver has been loaded.

IS_CANT_OPEN_DEVICE

An attempt to initialize or select the camera failed (no camera connected or initialization error).

IS_CAPTURE_RUNNING

A capturing operation is in progress and must be terminated first.

IS_DR_CANNOT_CREATE_SURFACE

The image surface or overlay surface could not be created.

IS_DR_CANNOT_CREATE_TEXTURE

The texture could not be created.

IS_DR_CANNOT_CREATE_VERTEX_BUFFER

The vertex buffer could not be created.

IS_DR_DEVICE_OUT_OF_MEMORY

Not enough graphics memory available.

IS_DR_LIBRARY_NOT_FOUND

The DirectRenderer library could not be found.

IS_INVALID_BUFFER_SIZE

The image memory has an inappropriate size to store the image in the desired format.

IS_INVALID_CAMERA_TYPE

The camera type defined in the .ini file does not match the current camera model.

IS_INVALID_CAPTURE_MODE

The function can not be executed in the current camera operating mode (free run, trigger or standby).

IS_INVALID_CAMERA_HANDLE

Invalid camera handle

IS_INVALID_MEMORY_POINTER

Invalid pointer or invalid memory ID

IS_INVALID_MODE

Camera is in standby mode, function not allowed

IS_INVALID_PARAMETER

One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode.

IS_INVALID_PIXEL_CLOCK

This setting is not available for the currently set pixel clock frequency.

IS_IO_REQUEST_FAILED

An IO request from the uEye driver failed. Possibly the versions of the ueye_api.dll (API) and the driver file (ueye_usb.sys or ueye_eth.sys) do not match.

IS_NO_ACTIVE_IMG_MEM

No active image memory available. You must set the memory to active using the is_SetImageMem() function or create a sequence using the is_AddToSequence() function.

IS_NO_SUCCESS

General error message

IS_NOT_CALIBRATED

The camera does not contain any calibration data.

IS_NOT_SUPPORTED

The camera model used here does not support this function or setting.

IS_NULL_POINTER

Invalid array

IS_OUT_OF_MEMORY

No memory could be allocated.

IS_SEQUENCE_BUF_ALREADY_LOCKED

The memory could not be locked. The pointer to the buffer is invalid.

IS_SUCCESS

Function executed successfully

IS_TIMED_OUT

A timeout occurred. An image capturing process could not be terminated within the allowable period.

IS_TRIGGER_ACTIVATED

The function cannot be used because the camera is waiting for a trigger signal.

Related functions

is_SetBinning()

is_AOI()

is_ImageFormat()

is_PixelClock()

© 2022 IDS Imaging Development Systems GmbH