Table Of Contents

Shape Match Tool (G Dataflow)

Last Modified: June 25, 2019

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

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

connector_pane_image
datatype_icon

image src

Reference to the source image.

datatype_icon

image template

Reference to the 8-bit binary template to search.

datatype_icon

image dst

Reference to any binary image that contains the objects from image src that match the object in the image template.

datatype_icon

scale invariance?

Boolean value that specifies whether to use size or scale invariance when matching objects in the source image to the template object.

TRUE Uses size or scale invariance when matching objects in the source image to the template object.
FALSE Does not use size or scale invariance when matching objects in the source image to the template object.

Default: TRUE

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

tolerance

Maximum allowed deviation between the template shape and similar shapes in the image.

Valid values are between 0 and 1.

datatype_icon

connectivity 4/8?

Boolean value that specifies the mode of connectivity used by the algorithm for particle detection.

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

The connectivity mode directly determines whether an adjacent pixel belongs to the same particle or a different particle.

Default: 8

datatype_icon

image dst out

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.

datatype_icon

shape reports

Array of clusters in which each cluster contains information on the matched objects.

datatype_icon

Global Rectangle

Bounding rectangle of the object.

datatype_icon

x1Left

X-coordinate of the top-left corner of the rectangle.

datatype_icon

y1Top

Y-coordinate of the top-left corner of the rectangle.

datatype_icon

x2Right

X-coordinate of the bottom-right corner of the rectangle.

datatype_icon

y2Bottom

Y-coordinate of the bottom-right corner of the rectangle.

datatype_icon

Centroid

Point-coordinate cluster containing the location of the centroid of the object.

datatype_icon

Object Size

Size, in pixels, of the object.

datatype_icon

Score

Output, between 1 and 1000, that specifies how similar the object in the image is to the template.

A score of 1000 implies a perfect match.

datatype_icon

number of matches

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

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Match Operation Details

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

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics