SearchWin Property
Runtime only
Applies To
Vision Objects: Blob, BoxFinder, CodeReader, ColorMatch, Contour, CornerFinder, Correlation, DefectFinder, Geometric, ImageOp, LineFinder, OCR, Text
Description
Defines the position and size of a search window.
Usage
When SearchWinType ≠ Arc
VGet Sequence.Object.SearchWin, LeftVar, TopVar, WidthVar, HeightVar
VSet Sequence.Object.SearchWin, Left, Top, Width, Height
- Sequence
- Name of a sequence or string variable containing a sequence name.
- Object
- Name of an object or string variable containing an object name. The object must exist in the specified sequence.
- LeftVar
- Integer variable representing the left position of the upperleft corner of the search window (in Pixels). Gets or sets a value from SearchWinLeft property.
- TopVar
- Integer variable representing the top position of the upperleft corner of the search window (in Pixels). Gets or sets a value from SearchWinTop property.
- WidthVar
- Integer variable representing the width of the search window (in Pixels). Gets or sets a value from SearchWinWidth property.
- HeightVar
- Integer variable representing the height of the search window (in Pixels). Gets or sets a value from SearchWinHeight property.
- Left
- Integer expression representing the new left position of the upperleft corner of the search window (in Pixels).
- Top
- Integer expression representing the new top position of the upperleft corner of the search window (in Pixels).
- Width
- Integer expression representing the new width of the search window (in Pixels).
- Height
- Integer expression representing the new height of the search window (in Pixels).
When SearchWinType = Arc
VGet Sequence.Object.SearchWin, CenterXVar, CenterYVar, RadiusInnerVar, RadiusOuterVar
VSet Sequence.Object.SearchWin, CenterX, CenterY, RadiusInner, RadiusOuter
- Sequence
- Name of a sequence or string variable containing a sequence name.
- Object
- Name of an object or string variable containing an object name. The object must exist in the specified sequence.
- CenterXVar
- Integer variable representing the center position of X of the search window (in Pixels). Gets or sets a value from SearchWinCenterX property.
- CenterYVar
- Integer variable representing the center position of Y of the search window (in Pixels). Gets or sets a value from SearchWinCenterY property.
- RadiusInnerVar
- Integer variable representing the radius size of inner circumference of the search window (in Pixels). Gets or sets a value from SearchWinRadiusInner property.
- RadiusOuterVar
- Integer variable representing the radius size of outer circumference of the search window (in Pixels). Gets or sets a value from SearchWinRadiusOuter property.
- CenterX
- Integer expression representing the center of X coordinate of the search window (in Pixels).
- CenterY
- Integer expression representing the center of Y coordinate of the search window (in Pixels).
- RadiusInner
- Integer expression representing the radius size of inner circumference of the search window (in Pixels).
- RadiusOuter
- Integer expression representing the radius size of outer circumference of the search window (in Pixels).
Values
All Values are in pixels. See the SearchWinLeft, SearchWinTop, SearchWinWidth, SearchWinHeight SearchWinCenterX, SearchWinCenterY, SearchWinRadiusInner, and SearchWinRadiusOuter Properties for exact value data.
- SearchWinLeft Property
- SearchWinTop Property
- SearchWinWidth Property
- SearchWinHeight Property
- SearchWinCenterX Property
- SearchWinCenterY Property
- SearchWinRadiusInner Property
- SearchWinRadiusOuter Property
Remarks
The SearchWin property was added to provide easy access to the SearchWinTop, SearchWinLeft, SearchWinWidth, and SearchWinHeight Properties or SearchWinCenterX, SearchWinCenterY, SearchWinRadiusInner, and SearchWinRadiusOuter Properties from the SPEL+ Language. The SearchWin property allows the setting of all four properties with one function call. There are cases where the user may want to define the position and size of the search window dynamically and for that reason the SearchWin property was created.
The Left and Top values specify the location of the upperleft corner of the window, even when the window is rotated.
SearchWinRadiusInner and SearchWinRadiusOuter originally use a real value, however, use an integer value only when executing VSet and VGet with this property.
Avoid setting SearchWin too large. If the value is too large, the detection time gets longer and may also result in false detection.
See Also
Blob Object, CodeReader Object, Correlation Object, Geometric Object, ImageOp Object, LineFinder Object, OCR Object, SearchWinCenterX Property, SearchWinCenterY Property, SearchWinHeight Property, SearchWinLeft Property, SearchWinRadiusInner Property, SearchWinRadiusOuter Property, SearchWinTop Property, SearchWinWidth Property, BoxFinder Object, Contour Object, CornerFinder Object, Text Object