Image Matching Activity
The Image Matching activity searches for a target image within a specified source image. It can perform a search across the entire source image or within a defined region using X-Y coordinates, width, and height. Upon a successful match, the activity returns the center X-Y coordinates, width, and height of the found image.
| Field | Description | Requirement |
|---|---|---|
| Source image | Specifies the file path of the source image. This field is mutually exclusive with Source image Base64. | Required |
| Source image Base64 | Specifies the source image as a Base64 string. This field is mutually exclusive with Source image. | Required |
| Searched image | Specifies the file path of the image to be searched for within the source image. This field is mutually exclusive with Searched image Base64. | Required |
| Searched image Base64 | Specifies the image to be searched for as a Base64 string. This field is mutually exclusive with Searched image. | Required |
| X-coordinate | Defines the starting X-coordinate for the search area. If used, Y-coordinate, Width, and Height must also be provided to define a specific search region. If left empty, the search covers the entire source image. | Optional |
| Y-coordinate | Defines the starting Y-coordinate for the search area. If used, X-coordinate, Width, and Height must also be provided to define a specific search region. If left empty, the search covers the entire source image. | Optional |
| Width | Defines the width of the search area. If used, X-coordinate, Y-coordinate, and Height must also be provided to define a specific search region. If left empty, the search covers the entire source image. | Optional |
| Height | Defines the height of the search area. If used, X-coordinate, Y-coordinate, and Width must also be provided to define a specific search region. If left empty, the search covers the entire source image. | Optional |
| Start scale | Specifies the initial scale factor (e.g., 0.1, 1.0, 2.0) to use when attempting to find the searched image. This is used for scaled image matching. | Optional |
| End scale | Specifies the final scale factor (e.g., 0.1, 1.0, 2.0) to use when attempting to find the searched image. This is used for scaled image matching. | Optional |
| Scale step | Specifies the incremental coefficient for scaling between the start and end scales. | Optional |
| Match score | Sets the minimum similarity percentage (e.g., 0.80 for 80%) required for an image match to be considered successful. | Optional |
| Return x-position | Assigns the X-coordinate of the center point of the matched image to this variable. | Required |
| Return y-position | Assigns the Y-coordinate of the center point of the matched image to this variable. | Required |
| Return height | Assigns the height of the matched image to this variable. | Required |
| Return width | Assigns the width of the matched image to this variable. | Required |
Action Types & Examples
Return x-position
- Format: digit
- Example Result:
x
Return y-position
- Format: digit
- Example Result:
y
Return height
- Format: digit
- Example Result:
h
Return width
- Format: digit
- Example Result:
w
Implementation Examples
Field Setup - Source image: C:\Robustarobusta.png - Source image Base64: iVBORw0KGgoAAAANSUhEUgAA… - Searched image: C:\Robustarobusta_logo.png - Searched image Base64: iVBORw0KGgoAAAANSUhEUgAA… - X-coordinate: 250 - Y-coordinate: 170 - Width: 100 - Height: 75 - Start scale: 1.0 - End scale: 2.0 - Scale step: 0.1 - Match score: 0.80
Execution Parameters - Return x-position: x - Return y-position: y - Return height: h - Return width: w
Technical Notes
The values for height and width must be an integer.