Skip to main content

Find Image

Locates an image on the screen and returns its position coordinates and confidence level.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.

Inputs​

This node does not have direct inputs. It uses a reference image for matching.

Options​

  • Confidence - Minimum confidence level for image recognition (default: 0.95).

Outputs​

  • Confidence - Actual confidence level of the found image match.
  • X Coordinate - X coordinate of the top-left corner of the found image.
  • Y Coordinate - Y coordinate of the top-left corner of the found image.

How It Works​

The Find Image node searches for a specified image on the screen and returns its position. When executed, the node:

  1. Downloads and prepares the reference image if needed
  2. Takes a screenshot of the current screen
  3. Uses OpenCV template matching to find the image with the specified confidence level
  4. Returns the coordinates and confidence of the best match found

Requirements​

  • Valid reference image for matching
  • Confidence value between 0 and 1

Error Handling​

The node will return specific errors in the following cases:

  • Empty image - "Empty Image"
  • Could not read image - "Could not read image"
  • Missing confidence - "Confidence can not be empty"
  • Invalid confidence format - "Confidence is not valid"
  • Confidence out of range - "Confidence must be between 0 and 1"
  • Image not found - "Max confidence is too low(). Could not find template in scene"

Usage Notes​

  • The confidence level affects the accuracy of image matching
  • Higher confidence values require more precise image matching
  • Lower confidence values may result in false positives but can handle variations better
  • The returned coordinates represent the top-left corner of the found image
  • This node is useful for locating UI elements before performing actions on them
  • Works best with high-contrast, static images
  • The actual confidence returned may be higher than the minimum threshold specified