THORLABS DCU223x User Manual

© 2013 Thorlabs GmbH
4 Programming (SDK)
435
4.5.40 is_SetImagePos
USB 2.0
USB 2.0
Syntax
INT is_SetImagePos (HIDS hCam, INT x, INT y)
Description
Attention
This function is obsolete and should not be used anymore. We recommend to use the is_AOI() function
instead (see also Obsolete functions ).
is_SetImagePos() determines the position of an area of interest (AOI) in the display window. When used
together with the is_SetAOI() function, you can cut out an area of interest of the full video image.
To avoid a positional mismatch between the display area and the image area, make sure to call the functions in the
correct order. Starting from the original image, it is mandatory to keep to the following order:
1. is_SetAOI()
2. is_SetImagePos()
Attention
Changes to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time. After
executing is_SetImagePos(), calling the following functions is recommended in order to keep the defined
camera settings:
is_SetFrameRate()
is_SetExposureTime()
If you are using the DCx Camera's flash function: is_SetFlashStrobe()
Input parameters
The x and y parameters represent an offset with respect to the upper left image corner. The cut window is copied to
the start position in the memory. If you want the image to be copied to the same offset within the memory, you can
link the new position with a logical OR to the IS_SET_IMAGE_POS_X_ABS and IS_SET_IMAGE_POS_Y_ABS
parameters.
hCam
Camera handle
x
0...xMax
Sets the horizontal position
0...xMax
| IS_SET_IMAGE_POS_X_ABS
Applies the absolute position to the memory as well.
IS_GET_IMAGE_POS_X
Returns the current x position.
IS_GET_IMAGE_POS_X_MIN
Returns the minimum value for the horizontal AOI
position.
IS_GET_IMAGE_POS_X_MAX
Returns the maximum value for the horizontal AOI
position.
IS_GET_IMAGE_POS_X_INC
Returns the increment for the horizontal AOI position.
IS_GET_IMAGE_POS_X_ABS
Returns the absolute horizontal position in the memory.
IS_GET_IMAGE_POS_Y
Returns the current Y position.
IS_GET_IMAGE_POS_Y_MIN
Returns the minimum value for the vertical AOI position.
IS_GET_IMAGE_POS_Y_MAX
Returns the maximum value for the vertical AOI
position.
IS_GET_IMAGE_POS_Y_INC
Returns the increment for the vertical AOI position.
IS_GET_IMAGE_POS_Y_ABS
Returns the absolute vertical position in the memory.
159
379
414
414
329
427
431

THORLABS DCU223x Specifications

General

Brand	THORLABS
Model	DCU223x
Category	Security Camera
Language	English