 |
 |
|---|---|
USB 2.0 GigE |
USB 2.0 GigE |
Syntax
INT is_SetImagePos (HIDS hCam, INT x, INT y)
Description
|
This function is obsolete and should not be used anymore. We recommend to use the is_AOI() function instead. |
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:
2.is_SetImagePos()
|
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() •If you are using the uEye's flash function: is_IO() |
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.
Return values
IS_SUCCESS |
Function executed successfully |
IS_NO_SUCCESS |
General error message |
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. |
When used with |
Current setting |
IS_INVALID_MODE |
Camera is in standby mode, function not allowed |
Related functions
•is_AOI()
•is_ImageFormat()
Example
Fig. 5: Examples for is_SetImagePos
