Table Of Contents

Match Multiple Geometric Patterns (G Dataflow)

Last Modified: June 25, 2019

Matches the templates specified in multiple geometric template session to the target image.

connector_pane_image
datatype_icon

multiple template session in

Reference to the multiple geometric template on which this node operates.

datatype_icon

image in

Reference to the source image.

datatype_icon

ROI descriptor

Region of interest specifying the location of the sample in the image.

The ROI must be one rectangle or one rotated rectangle. If ROI descriptor is empty or not connected, the entire image is considered to be the region of interest.

datatype_icon

Global Rectangle

Coordinates of the bounding rectangle.

datatype_icon

Contours

Individual shapes that define an ROI.

datatype_icon

ID

Object specifying if contour is the external or internal edge of an ROI.

datatype_icon

Type

Shape type of the contour.

datatype_icon

Coordinates

Relative position of the contour.

datatype_icon

labels to override match options

Array of labels that identify the templates to override the default match options.

Refer to the values specified for override match options to determine which options are overridden.

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

override match options

Array of match options used to override the default match options set using the Learn Multiple Geometric Patterns node.

This array is used with labels to override match options to override match options corresponding to one or more templates specified in multiple geometric template session. This node uses the following rules to determine which match options are overridden:

  • If the array is empty, then all templates use the options set during the learn phase.
  • If there is only one element in the array, the match options that are overridden depend on the value of labels to override match options.
    • If labels to override match options is empty, then the algorithm uses the values in the array element for all the templates.
    • If labels to override match options is not empty, then the algorithm uses the values in the array element for the templates corresponding to the specified labels.
  • If there is more than one element in the array, labels to override match options must have the same number of elements as the specified array. The node makes a one to one correspondence between the override match options and the labels to override match options to determine which template match options are overridden.
datatype_icon

match setup data

String that contains information from the Setup Match Geometric Pattern node or the Advanced Setup Match Geometric Pattern node.

Set this value to an empty string if you want to use default parameters for all options.

datatype_icon

number of matches

Number of valid matches expected.

datatype_icon

minimum match score

Smallest score a match can have to be considered valid.

The data range for a match is between 0 and 1000.

datatype_icon

multiple template session out

Reference to the new multiple geometric template.

datatype_icon

image out

Reference to the image from which features were extracted.

datatype_icon

matches (pixel)

Information about a match found in the image.

datatype_icon

Position

Point-coordinate cluster corresponding to the location of the template origin.

datatype_icon

Angle

Rotation angle, in degrees, of the template at the current match location.

datatype_icon

Scale

Ratio of the size of the matched template relative to the original template image, expressed as a percentage.

datatype_icon

Score

Input that ranks the match results on a scale of 0 to 1000, where 0 equals no match and 1000 equals a perfect match.

datatype_icon

Bounding Box

Array of five points that define the boundary of the template.

datatype_icon

Contrast Reversed

Boolean value that specifies whether the match is an inverse of the template image.

TRUE Match is an inverse of the template image.
FALSE Match is not the inverse of the template image.
datatype_icon

Occlusion %

Percentage of the match that is occluded.

datatype_icon

Template Target Curve Score

Input that specifies how closely the curves in the match region of the inspection, or target, image match the curves in the template.

Score values can range from 0 to 1000, where a score of 1000 indicates that all template curves have a corresponding curve in the match region of the inspection image.

datatype_icon

Target Template Curve Score

Input that specifies how closely the curves in the match region of the inspection, or target, image match the curves in the template.

Score values can range from 0 to 1000, where a score of 1000 indicates that all curves in the match region of the inspection image have a corresponding curve in the template image. The node does not compute the Target Template Curve Score by default. Use the Advanced Setup Match Geometric Pattern node to configure the algorithm to compute this value.

datatype_icon

Correlation Score

Accuracy of the match obtained by comparing the template image to the match region using a correlation metric that compares the two regions as a function of their pixel values.

A score of 1000 indicates a perfect match, and a score of 0 indicates no match.

datatype_icon

matches (real-world)

Information about a match found in the image.

matches (real-world) may differ from matches (pixel) if image is a calibrated image. If image is a calibrated image, position, angle, and bounding box are returned in real-world units.

datatype_icon

Position

Point-coordinate cluster corresponding to the location of the template origin.

datatype_icon

Angle

Rotation angle, in degrees, of the template at the current match location.

datatype_icon

Scale

Ratio of the size of the matched template relative to the original template image, expressed as a percentage.

datatype_icon

Score

Input that ranks the match results on a scale of 0 to 1000, where 0 equals no match and 1000 equals a perfect match.

datatype_icon

Bounding Box

Array of five points that define the boundary of the template.

datatype_icon

Contrast Reversed

Boolean value that specifies whether the match is an inverse of the template image.

TRUE Match is an inverse of the template image.
FALSE Match is not the inverse of the template image.
datatype_icon

Occlusion %

Percentage of the match that is occluded.

datatype_icon

Template Target Curve Score

Input that specifies how closely the curves in the match region of the inspection, or target, image match the curves in the template.

Score values can range from 0 to 1000, where a score of 1000 indicates that all template curves have a corresponding curve in the match region of the inspection image.

datatype_icon

Target Template Curve Score

Input that specifies how closely the curves in the match region of the inspection, or target, image match the curves in the template.

Score values can range from 0 to 1000, where a score of 1000 indicates that all curves in the match region of the inspection image have a corresponding curve in the template image. The node does not compute the Target Template Curve Score by default. Use the Advanced Setup Match Geometric Pattern node to configure the algorithm to compute this value.

datatype_icon

Correlation Score

Accuracy of the match obtained by comparing the template image to the match region using a correlation metric that compares the two regions as a function of their pixel values.

A score of 1000 indicates a perfect match, and a score of 0 indicates no match.

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.
datatype_icon

matched labels

Array that specifies the template label for corresponding matches.

Configure Multiple Geometric Templates

Use one of the following methods to configure multiple geometric templates for use with this node.

  • Use the Read Multiple Geometric Template node to load a multiple geometric template saved using the Write Multiple Geometric Template node.
  • Use the Learn Multiple Geometric Patterns node to learn the multiple geometric template.

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