 |
 |
|---|---|
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
|
This function is obsolete and should not be used anymore. We recommend to use the is_AOI() function instead. |
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
|
By default, the window size for auto AOIs is always maximum, i.e. it corresponds to the current image AOI. After a change to the image geometry (by resetting an image AOI, by binning or sub-sampling), the auto AOIs will always be reset to the image AOI value (i.e. to maximum size). This means that it might be necessary to set the AOIs for the auto features again manually. |
|
Changes to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time. After executing is_SetAOI(), 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 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 (Example).
hCam |
Camera handle |
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
•is_SetBinning()
•is_SetSubSampling()
•is_SetAutoParameter()
Fig. 1: Examples for is_SetAOI
