Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

IMAQ Match Geometric Pattern VI

NI Vision 2011 for LabVIEW Help

Edition Date: June 2011

Part Number: 370281P-01

»View Product Info
Owning Palette: Geometric Pattern Matching (Feature Based)
Requires: NI Vision Development Module

Searches for a pattern, or template image, in the inspection image.

Details

IMAQ Match Geometric Pattern

/images/reference/en-XX/help/370281P-01/ccclst.gif

ROI Descriptor specifies the region of the inspection image in which to perform geometric matching. This region must be a single rectangle or rotated rectangle contour. By default, the VI uses the entire inspection image for matching.

/images/reference/en-XX/help/370281P-01/c1di32.gif

Global Rectangle contains the coordinates of the bounding rectangle.

/images/reference/en-XX/help/370281P-01/c1dcclst.gif

Contours are each of the individual shapes that define an ROI.

/images/reference/en-XX/help/370281P-01/cenum.gif

ID refers to whether the contour is the external or internal edge of an ROI.

/images/reference/en-XX/help/370281P-01/cu32.gif

Type is the shape type of the contour.

/images/reference/en-XX/help/370281P-01/c1di32.gif

Coordinates indicates the relative position of the contour.

/images/reference/en-XX/help/370281P-01/cgenclasstagrefflat.gif

Image is a reference to the inspection image in which you want to search for the template image.

/images/reference/en-XX/help/370281P-01/cgenclasstagrefflat.gif

Template Image is a reference to the template for which you want to search during the matching phase. The template image is an output of the IMAQ Learn Geometric Pattern VI.

/images/reference/en-XX/help/370281P-01/cstr.gif

Match Geometric Pattern Setup Data is a string that contains information from the IMAQ Setup Match Geometric Pattern VI or the IMAQ Advanced Setup Match Geometric Pattern VI. If this input is not connected, the VI uses default parameters for all unconfigured options.

/images/reference/en-XX/help/370281P-01/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.

/images/reference/en-XX/help/370281P-01/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.

/images/reference/en-XX/help/370281P-01/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.

/images/reference/en-XX/help/370281P-01/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.

/images/reference/en-XX/help/370281P-01/ci32.gif

Number of Matches Requested is the number of valid matches expected.

/images/reference/en-XX/help/370281P-01/csgl.gif

Minimum Match Score is the smallest score a match can have to be considered valid. The data range for a match is between 0 and 1000.

/images/reference/en-XX/help/370281P-01/i1dcclst.gif

Matches (pixel) contains information about a match found in the image.

/images/reference/en-XX/help/370281P-01/inclst.gif

Position is a point-coordinate cluster corresponding to the location of the template origin.

/images/reference/en-XX/help/370281P-01/isgl.gif

Angle is the rotation angle, in degrees, of the template at the current match location.

/images/reference/en-XX/help/370281P-01/isgl.gif

Scale is the ratio of the size of the matched template relative to the original template image, expressed as a percentage.

/images/reference/en-XX/help/370281P-01/isgl.gif

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

/images/reference/en-XX/help/370281P-01/i1dnclst.gif

Bounding Box is an array of five points that define the boundary of the template.

/images/reference/en-XX/help/370281P-01/ibool.gif

Contrast Reversed specifies whether the match is an inverse of the template image. This parameter is TRUE if the match is an inverse of the template image. For example, the match is a white object on a black background but the template image is a black object on a white background. This parameter is FALSE if the match is not the inverse of the template image.

/images/reference/en-XX/help/370281P-01/isgl.gif

Occlusion % is the percentage of the match that is occluded.

/images/reference/en-XX/help/370281P-01/isgl.gif

Template Target Curve Score 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.

/images/reference/en-XX/help/370281P-01/isgl.gif

Target Template Curve Score 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.

Note  The VI does not compute the Target Template Curve Score by default. Use the IMAQ Advanced Setup Match Geometric Pattern VI to configure the algorithm to compute this value.
/images/reference/en-XX/help/370281P-01/isgl.gif

Correlation Score specifies the 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.

/images/reference/en-XX/help/370281P-01/i1dcclst.gif

Matches (real-world) contains information about a match found in the image.

Note   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.
/images/reference/en-XX/help/370281P-01/inclst.gif

Position is a point-coordinate cluster corresponding to the location of the template origin.

/images/reference/en-XX/help/370281P-01/isgl.gif

Angle is the rotation angle, in degrees, of the template at the current match location.

/images/reference/en-XX/help/370281P-01/isgl.gif

Scale is the ratio of the size of the matched template relative to the original template image, expressed as a percentage.

/images/reference/en-XX/help/370281P-01/isgl.gif

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

/images/reference/en-XX/help/370281P-01/i1dnclst.gif

Bounding Box is an array of five points that define the boundary of the template.

/images/reference/en-XX/help/370281P-01/ibool.gif

Contrast Reversed specifies whether the match is an inverse of the template image. This parameter is TRUE if the match is an inverse of the template image. For example, the match is a white object on a black background but the template image is a black object on a white background. This parameter is FALSE if the match is not the inverse of the template image.

/images/reference/en-XX/help/370281P-01/isgl.gif

Occlusion % is the percentage of the match that is occluded.

/images/reference/en-XX/help/370281P-01/isgl.gif

Template Target Curve Score 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.

/images/reference/en-XX/help/370281P-01/isgl.gif

Target Template Curve Score 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.

Note  The VI does not compute the Target Template Curve Score by default. Use the IMAQ Advanced Setup Match Geometric Pattern VI to configure the algorithm to compute this value.
/images/reference/en-XX/help/370281P-01/isgl.gif

Correlation Score specifies the 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.

/images/reference/en-XX/help/370281P-01/ii32.gif

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

/images/reference/en-XX/help/370281P-01/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.

/images/reference/en-XX/help/370281P-01/ibool.gif

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

/images/reference/en-XX/help/370281P-01/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.

/images/reference/en-XX/help/370281P-01/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

Use one of the following methods to configure the template image for use with this VI.

  • Use the IMAQ Read Image And Vision Info VI to load a template image that was created previously using the NI Vision Template Editor.
    Note  You can access the NI Vision Template Editor from Start»All Programs»National Instruments»Vision»Template Editor.
  • Use the IMAQ Learn Geometric Pattern VI to learn the template image.

 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit