NI Vision for LabVIEW

IMAQ Get Template Information VI

  • Updated2023-02-21
  • 4 minute(s) read
Owning Palette: Searching and Matching
Requires: NI Vision Development Module

Retrieves the information used to learn the template image.

IMAQ Get Template Information

cgenclasstagrefflat.gif

Template Image is a reference to the template image. The template image contains the data that defines the template pattern for matching.

cgenclasstagrefflat.gif

Mask Image is a reference to the destination image where the VI writes the returned mask values.

ci32.gif

Algorithm specifies the pattern matching algorithm used to learn the template information.

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.

cgenclasstagrefflat.gif

Weight Map is the image to specify weights to suppress noise and false defects in the defect map. Pixels with lower weights are enhanced and pixels with higher weights are suppressed in the defect map. Weight Map is used with the IMAQ Calculate Defect Map VI.

icclst.gif

Match Offset contains the position and angle of the match offset used while learning the template.

igenclasstagrefflat.gif

Template Image (duplicate) is a reference to the source template image

igenclasstagrefflat.gif

Mask Image Out is a reference to the destination image that contains the returned mask values. If no mask was used to learn the template image, Mask Image Out is empty.

inclst.gif

Pyramid Level contains information about the maximum and optimal pyramid levels found while learning the template.

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.

igenclasstagrefflat.gif

Weight Map Out is the image to specify weights to suppress noise and false defects in the defect map. Pixels with lower weights are enhanced and pixels with higher weights are suppressed in the defect map. Weight Map Out is used with the IMAQ Calculate Defect Map VI.

Log in to get a better experience