219SDK (Software development Kit)
© 2010 Thorlabs
7.3.69
is_SetAOI
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
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()
is_SetExposureTime()
If you are using the DCx camera's flash function: is_SetFlashStrobe()
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.
259
251
257
To Next Page
Loading...
Need help?
General
