Home > C: Programming > Obsolete Functions > | History back Previous chapter Next chapter Print |
is_SetAOI |
uEye Camera Manual Version 3.80
is_SetAOI
USB 2.0 GigE |
USB 2.0 GigE |
Syntax
INT is_SetAOI (HIDS hCam,
INT type,
INT* pXPos, INT* pYPos,
INT* pWidth, INT* pHeight)
Description
|
is_SetAOI() can be used to set the size and position of an area of interest (AOI) within an image. The following AOIs can be defined:
• | Image AOI – display of an image portion |
• | Auto Brightness AOI – reference area of interest for automatic brightness control |
• | Auto Whitebalance AOI – reference area of interest of automatic white balance control |
|
|
Input Parameters
The pXPos and pYPos 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_IMAGEPOS_X_ABS and IS_SET_IMAGEPOS_Y_ABS parameters.
hCam |
Camera handle |
type |
|
IS_SET_IMAGE_AOI |
Sets an image AOI. |
IS_GET_IMAGE_AOI |
Returns the current image AOI. |
IS_SET_AUTO_BRIGHT_AOI |
Sets average AOI values for auto gain and auto shutter. |
IS_GET_AUTO_BRIGHT_AOI |
Returns the current auto brightness AOI. |
IS_SET_AUTO_WB_AOI |
Sets an auto white balance AOI. |
IS_GET_AUTO_WB_AOI |
Returns the current auto white balance AOI. |
pXPos |
Pointer to the horizontal position of the AOI Returns the current setting when used together with the IS_GET_... parameters. |
0...XPosMax |
Applies the absolute position to the memory as well. |
pYPos |
Pointer to the vertical position of the AOI Returns the current setting when used together with the IS_GET_... parameters. |
0...YPosMax |
Applies the absolute position to the memory as well. |
pWidth |
Pointer to the width of the AOI Returns the current setting when used together with the IS_GET_... parameters. |
pHeight |
Pointer to the height of the AOI Returns the current setting when used together with the IS_GET_... parameters. |
Return Values
IS_SUCCESS |
Function executed successfully |
IS_NO_SUCCESS |
General error message |
Related Functions
Figure 152: Examples for is_SetAOI