IMAQ Shape Match Tool VI

LabView NI Vision

IMAQ Shape Match Tool VI

Owning Palette: Searching and MatchingInstalled With: NI Vision Development Module

Finds objects in an image whose shape matches the shape of the object specified by a template.

Note  This VI modifies the source image. If you need the original source image, create a copy of the image using the IMAQ Copy VI before using this VI.
Note  The input image must be a binary image that contains only pixel values of 0 or 1.

Details

IMAQ Shape Match Tool

cbool.gif

Scale Invariance? (Yes) specifies whether to use size or scale invariance when matching objects in the source image to the template object.

cdbl.gif

Tolerance indicates the maximum allowed deviation between the template shape and similar shapes in the image. Valid values are between 0 and 1.

cgenclasstagrefflat.gif

Image Src is a reference to the source image.

cgenclasstagrefflat.gif

Image Template is a reference to the 8-bit binary template for which you want to search.

cgenclasstagrefflat.gif

Image Dst is a reference to an binary image that contains the objects from the Image Src that match the object in the Image Template.

cerrcodeclst.gif

error in (no error) describes the error status before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.

cbool.gif

status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.

ci32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

cstr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

cbool.gif

Connectivity 4/8 (8) specifies the type of connectivity used by the algorithm for particle detection. The connectivity mode directly determines whether an adjacent pixel belongs to the same particle or a different particle. The default is 8. The following values are possible:

8 (TRUE) Particle detection is performed in connectivity mode 8
4 (FALSE) Particle detection is performed in connectivity mode 4
igenclasstagrefflat.gif

Image Dst Out is a reference to the destination image. If Image Dst is connected, Image Dst Out is the same as Image Dst. Otherwise, Image Dst Out refers to the image referenced by Image Src.

ii32.gif

Number of Matches is the number of template matches found in the inspection image based on the input settings.

i1dcclst.gif

Shape Report is an array of clusters in which each cluster contains the following information on the matched objects:

inclst.gif

Global Rectangle contains the bounding rectangle of the object.

ii32.gif

x1Left indicates the x-coordinate of the top-left corner of the rectangle.

ii32.gif

y1Top indicates the y-coordinate of the top-left corner of the rectangle.

ii32.gif

x2Right indicates the x-coordinate of the bottom-right corner of the rectangle.

ii32.gif

y2Bottom indicates the y-coordinate of the bottom-right corner of the rectangle.

inclst.gif

Centroid is a point-coordinate cluster containing the location of the centroid of the object.

iu32.gif

Object Size is the size in pixels of the object.

idbl.gif

Score (between 1 and 1000) specifies how similar the object in the image is to the template. A score of 1000 implies a perfect match.

ierrcodeclst.gif

error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.

ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

ii32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

istr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

Details

The matching process is invariant to rotation and can be set to be invariant to the scale of the objects. This VI requires that the objects have been separated from the background and that the input image is binary. Before performing the match operation, this VI labels the image to give each object in the image a unique ID.

Refer to the NI Developer Zone document How to Use the Shape Matching Functionality for more information about shape matching.