Match

class Match

An object of class Match represents the result of a successful find operation. It has the rectangle dimension of the image, that was used to search. It knows the point of its upper left corner on an existing monitor, where it was found.

Since class Match extends class Region, all methods of class Region can be used with a match object.

Creating a Match, Getting Attributes

A match object is created as the result of an explicit find operation. It can be saved in a variable for later use with actions like click().

It has the rectangle dimension of the image, that was used to search. It knows the point of its upper left corner on an existing monitor, where it was found. It knows the similarity it was found with and a click point to be used, if set by a pattern.

For all other aspects, the features and attributes of class Region apply.

class Match

getScore()

Get the similarity score the image or pattern was found. The value is between 0 and 1.

getTarget()

Get the location object that will be used as the click point.

Typically, when no offset was specified by Pattern.targetOffset(), the click point is the center of the matched region. If an offset was given, the click point is the offset relative to the center.

Iterating over Matches after findAll()

A find operation Region.findAll() returns an iterator object that can be used to fetch all found matches as match objects one by one. A reference to the iterator is stored in the respective region and can be accessed using Region.getLastMatches().

Important to know:

• per definition, an iterator can be stepped through only once - it is empty afterwards

You can read more about the basics of operations with iterators from the description of Finder class. To save contained matches for later use, you can convert them to list.

Example: using while: with default screen

Example: using with: with default screen