imgSessionConfigureROI
Usage
rval imgSessionConfigureROI(SESSION_ID sid, uInt32 top, uInt32 left, uInt32 height, uInt32 width);
Purpose
Sets the acquisition region of interest (ROI). This function modifies the following attributes:
| IMG_ATTR_ROI_TOP |
| IMG_ATTR_ROI_LEFT |
| IMG_ATTR_ROI_HEIGHT |
| IMG_ATTR_ROI_WIDTH |
To use imgSessionConfigureROI, the ROI you set must be properly aligned. Use imgSessionFitROI function to ensure that the ROI is properly aligned.
Parameters
| Name | Type | Direction |
| sid | SESSION_ID | input |
| top | uInt32 | input |
| left | uInt32 | input |
| height | uInt32 | input |
| width | uInt32 | input |
| rval | Int32 | output |
Parameter Discussion
sid: valid SESSION_ID.
top: top offset of the first pixel to acquire.
left: left offset of the first pixel to acquire.
height: height of the area to acquire.
width: width of the area to acquire.
Return Value
This function returns 0 on success. On failure, this function returns an error code. For information about the error code, call imgShowError.