Patterns Vision Data Access Functions

This topic lists the Vision Data Access Functions that get values from a Patterns structure as input.

Note: 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.
Function Description

GetAngle(Patterns, [Index])

Returns the angle value.

Note: This function is supported by the FindPatMaxRedLine, and SortPatterns functions.

GetClutter(Patterns, [Index])

Returns the clutter score(the score of features found that are not part of the trained pattern.)

Note: This function is supported by the FindPatMaxRedLine function.

GetContrast(Patterns, [Index])
  • FindPatMaxRedLine contrast is the "relative" measure of contrast change between features in the trained pattern versus match features in search image, in percentage. Therefore, if feature contrast is similar or high to pattern contrast, reported Contrast will be ~100. If feature contrast is lower than pattern contrast, reported Contrast will be <100.
Note: This function is supported by the FindPatMaxRedLine function.

GetCoverage(Patterns, [Index])

Returns the coverage percentage.

Note: This function is supported by the FindPatMaxRedLine function.

GetGranCoarse(Patterns)

Returns the coarse granularity value.

Note: This function is supported by the TrainPatMaxRedLine function.

GetGranFine(Patterns)

Returns the fine granularity value.

Note: This function is supported by the TrainPatMaxRedLine function.

GetNFound(Patterns)

Returns the number of pattern matches found.

Note: This function is supported by the FindPatMaxRedLine, and SortPatterns functions.

GetScale(Patterns, [Index])

Returns the size of the match (compared to the trained pattern) as a percentage.

Note: This function is supported by the FindPatMaxRedLine, and SortPatterns functions.

GetScore(Patterns, [Index])

Returns the pattern response score value.

Note: This function is supported by the FindPatMaxRedLine, and SortPatterns functions.

GetTrained(Patterns)

Returns 1 if a pattern has been successfully learned, and 0 if a pattern cannot be trained from a Patterns structure.

Note: This function is supported by the TrainPatMaxRedLine function.

GetX(Patterns, [Index])

Returns a x-coordinate.

Note: This function is supported by the FindPatMaxRedLine, and SortPatterns functions.

GetY(Patterns, [Index])

Returns a y-coordinate.

Note: This function is supported by the FindPatMaxRedLine, and SortPatterns functions.