SetAOI

Syntax

LONG SetAOI (LONG type,
LONG* pXPos, LONG* pYPos,
LONG* pWidth, LONG* pHeight)

Description

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

Achtung

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.

Achtung

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

•SetFrameRate()

•SetExposureTime()

•If you are using the uEye's flash function: SetFlashStrobe()

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.

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 \| IS_SET_IMAGEPOS_X_ABS	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 \| IS_SET_IMAGEPOS_Y_ABS	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 properties

•IFFormat

Related functions

•IsIFArbitraryAOISupported()

•SetBinning()

•SetSubSampling()

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

For technical questions please contact you local distributor or use the support form on our website.

Home > Function descriptions >	History back Previous chapter Next chapter Print
SetAOI