F_VN_SetRoi_TcVnRectangle_UDINT
Sets a region of interest (ROI) within an image.
Syntax
Definition:
FUNCTION F_VN_SetRoi_TcVnRectangle_UDINT : HRESULT
VAR_IN_OUT
stRoi : TcVnRectangle_UDINT;
END_VAR
VAR_INPUT
ipDestImage : ITcVnImage;
hrPrev : HRESULT;
END_VAR
Inputs
|
Name |
Type |
Description |
|---|---|---|
|
ipDestImage |
Destination image | |
|
hrPrev |
HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.) |
Return valueFurther information
Like the function F_VN_SetRoi, the function F_VN_SetRoi_TcVnRectangle_UDINT sets a Region of Interest. However, it doesn't accept the rectangle parameters individually, but as a structure of the type TcVnRectangle_UDINT.
This makes it possible, for example, to set the ROI directly with the result of the function F_VN_UprightBoundingRectangle.
Application
The setting of an ROI around a found contour looks like this:
hr := F_VN_UprightBoundingRectangle(ipContour, stRoi, hr);
hr := F_VN_SetRoi_TcVnRectangle_UDINT(stRoi, ipImageWork, hr);
Related functions
- F_VN_SetRoi for setting a Region of Interest
- F_VN_GetRoi for retrieving the set Region of Interest
- F_VN_ResetRoi for resetting the Region of Interest on the entire image
- F_VN_CopyImageRegion for copying an image region
Required License
TC3 Vision Base
System Requirements
Development environment | Target platform | PLC libraries to include |
|---|---|---|
TwinCAT V3.1.4024.54 or later | PC or CX (x64) with PL50, e.g. Intel 4-core Atom CPU | Tc3_Vision |