SetImageAOI

Syntax

LONG SetImageAOI(LONG lPosX, LONG lPosY, LONG lWidth, LONG lHeight)

Description

Achtung

This function is obsolete and should not be used anymore. We recommend to use the SetAOI() function instead (see also Obsolete functions).

SetImageAOI() sets the area of interest of an uEye sensor. It’s a combination of SetImagePosition() and SetImageSize().

For position and size constraints please refer to the "Specifications: Sensors" chapter in the uEye Manual.

Achtung

Changes to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time. After executing SetImageAOI(), 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

lPosX	Horizontal starting point of the area of interest.
lPosY	Vertical starting point of the area of interest.
lWidth	Width of image / area of interest
lHeight	Height of image / area of interest.

Return values

IS_SUCCESS	Function executed successfully
IS_NO_SUCCESS	General error message

Example:

//Set the image position to X=32 and Y=80;
// set the image size to width=304 and height=200 :
//Using SetImagePos and SetImageSize:
ret = SetImagePos (32, 80);
ret = SetImageSize(304, 200);

Using SetImageAOI:
ret = SetImageAOI(32, 80, 304, 200);

Related functions

•SetAOI()

•SetImagePosition()

•SetImageSize()

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 > Obsolete functions >	History back Previous chapter Next chapter Print
SetImageAOI