Home > C: Programming > Obsolete Functions > History back  Previous chapter  Next chapter  Print  

is_SetImagePos

uEye Camera Manual Version 3.80

is_SetImagePos

Windows_Logo

Linux_Logo

USB 2.0

GigE

USB 2.0

GigE

Syntax

INT is_SetImagePos (HIDS hCam, INT x, INT y)

Description

Achtung

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

 

Achtung

Changes to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time. After executing is_SetBinning(), calling the following functions is recommended in order to keep the defined camera settings:

If you are using the uEye'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.

y


0...yMax

Sets the vertical position

0...yMax
| IS_SET_IMAGE_POS_Y_ABS

Applies the absolute position to the memory as well.

0

When returning settings via parameter x (s. above)

Return Values

IS_SUCCESS

Function executed successfully

IS_NO_SUCCESS

General error message

IS_INVALID_PARAMETER

Parameters x or y are invalid  (x, y < 0)

Current setting when used together with
IS_GET_IMAGE_POS parameters


IS_INVALID_MODE

Camera is in standby mode, function not allowed.

Related Functions

is_SetAOI()
is_ImageFormat()

Example

Funktion_is_SetImagePos_1

Funktion_is_SetImagePos_2

Figure 153: Examples for is_SetImagePos

Figure 153: Examples for is_SetImagePos


Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!


© 2010 IDS Imaging Development Systems GmbH
http://www.ids-imaging.com