Patterns
Each of the following functions references a Patterns data structure as the first parameter. Index (zero-based) determines which pattern is being indexed from the structure. For more information, see Pattern Match.
Function | Description | |||||||
---|---|---|---|---|---|---|---|---|
Returns the angle value. This function works with the following functions: FindPatMaxRedLineColor, FindPatMaxRedLine, FindPatMaxPatterns, FindPatterns and SortPatterns. |
||||||||
Returns the clutter score. Clutter is features that are found that are not part of the trained pattern. This function works with the following functions: FindPatMaxRedLineColor, FindPatMaxRedLine, and FindPatMaxPatterns. |
||||||||
Returns the column value. This function works with the following functions: FindPatMaxRedLineColor, FindPatMaxRedLine, FindPatMaxPatterns, FindPatterns and SortPatterns. |
||||||||
Returns the color score value (0 - 100). This function works only with the FindPatMaxRedLineColor function. Note:
When the referenced TrainPatMaxRedLineColor's Match Colors parameter is set to No Matching, the GetColorScore function returns 100.000.
|
||||||||
Returns the contrast value. This function works with the following functions: FindPatMaxRedLineColor, FindPatMaxRedLine, and FindPatMaxPatterns.
|
||||||||
Returns the coverage percentage. This function works with the following functions: FindPatMaxRedLineColor, FindPatMaxRedLine, and FindPatMaxPatterns. |
||||||||
Returns the error code for a pattern. This function works with the Pattern Match functions (TrainPatMaxRedLineColor, FindPatMaxRedLineColor, TrainPatMaxRedLine, FindPatMaxRedLine, TrainPatMaxPattern, FindPatMaxPatterns, FindPatterns and SortPatterns). |
||||||||
Returns the fit error score. This function works only with the FindPatMaxPatterns function. |
||||||||
Returns the coarse granularity value. This function works with the following functions: TrainPatMaxRedLineColor, TrainPatMaxRedLine, and TrainPatMaxPattern. |
||||||||
Returns the fine granularity value. This function works with the following functions: TrainPatMaxRedLineColor, TrainPatMaxRedLine, and TrainPatMaxPattern. |
||||||||
Returns a diagnostic code for information strings. This function works with the following functions: TrainPatMaxPattern and FindPatMaxPatterns. |
||||||||
Returns the information string. This function works with the following functions: TrainPatMaxPattern and FindPatMaxPatterns. |
||||||||
Returns the number of pattern matches found. This function works with the following functions: FindPatMaxRedLineColor, FindPatMaxRedLine, FindPatMaxPatterns, FindPatterns and SortPatterns. |
||||||||
Returns the proportion (on a scale of 0 to 1, where 0 equals completely within and 1 equals 100% outside) of the matching pattern's area found outside the search region. This function works only with the FindPatMaxPatterns function. |
||||||||
Returns the proportion (on a scale of 0 to 1, where 0 equals completely within and 1 equals 100% outside) of the matching pattern's features found outside the search region. This function works only with the FindPatMaxPatterns function. |
||||||||
Returns the row value. This function works with the following functions: FindPatMaxRedLineColor, FindPatMaxRedLine, FindPatMaxPatterns, FindPatterns and SortPatterns. |
||||||||
Returns the size of the match (compared to the trained pattern) as a percentage. This function works with the following functions: FindPatMaxRedLineColor, FindPatMaxRedLine, FindPatMaxPatterns, FindPatterns and SortPatterns. |
||||||||
Returns the size of the match in the X-direction (compared to the trained pattern) as a percentage. This function works only with the FindPatMaxPatterns function. |
||||||||
Returns the size of the match in the Y-direction (compared to the trained pattern) as a percentage. This function works only with the FindPatMaxPatterns function. |
||||||||
Returns the pattern response score value. This function works with the following functions: FindPatMaxRedLineColor, FindPatMaxRedLine, FindPatMaxPatterns, FindPatterns and SortPatterns. |
||||||||
Returns 1 if the tool successfully learned a pattern. Returns 0 if the tool cannot train a pattern from a Patterns structure. This function works with the following functions: TrainPatMaxPattern, TrainPatMaxRedLine, TrainPatMaxRedLineColor and FindPatterns. |