Image Recognition command

Use this command to search for an image within a source image.

Overview

Use this command to quickly search for an image within a source image and to readily automate any application that uses visual elements. You can capture and process various images of different sizes using HiDPI display.

Another major benefit of using image recognition is to locate an image after the image might be moved, for example, from one location on a web page to another.

Also, in some cases when application UI elements might not be available for automation you can use Image based automation. For example, when application is exposed over Citrix or when application accessed from RDP, or when object detection is not as reliable such as legacy applications, you can use the Image Recognition command.

The Image Recognition command offers the following operations:

Wait time
Specify the time in milliseconds to wait for images that are to be captured from windows that might take some time to load.
Select Image 1
Capture the image from an open window or select it from a file.
If capturing from an open window, you can also position your click location relative to an image. This is useful when the target image is blurred, has some background noise, or the target image is visible multiple times.
Select Image 2
Capture the image from an open window or select it from a file.
  • You can also select an easily identifiable image and position your click relative to it.
    Note: The relative click option requires Enterprise Client edition 11.0 and higher.
  • If using in conjunction with IF/ELSE command, select If the image is found, click it for the cross-hair to appear.
  • To return to the default cross-hair position (center of the image), click Reset Crosshair.
For faster image recognition:
  • Ensure Image2 is as small as possible.
  • If a particular color dominates the entire screen (say gray), make sure that the starting pixel of Image2 (the one on the upper left corner) does not include that color.
Image Occurrence
Use this option when the target image can be found multiple times. Here, you can use a variable when you do not know the number of times the image might appear on the screen. While using variables ensure you assign variables that support numeric values
Match Percentage
Use this option to specify the acceptable percentage of matching pixels between the two images.
For example, a 20% Match Percentage means that even if up to 80% of pixels mismatch between the two images, the images will be considered matching.
Tolerance
Use this option to specify the acceptable range of matching pixels.
A 0% Tolerance means the individual RGB values of the pixels being compared must match, exactly. A 20% Tolerance could allow the individual RGB values of the pixels to vary from + 20% to - 20% for a successful match.
  • While Match Percentage defines the extent of overall mismatch allowed between Image1 and Image2, Tolerance defines the extent of mismatch allowed between any two pixels under comparison.
  • The RGB color space uses 8 bits each for red, green and blue and can have integer values ranging from 0 to 255.
Comparison Mode
Select one of the methods of comparison:
  1. Advanced: This is the default selection. It is the most accurate mode as compared to other modes and provides better results in cases where screen resolution/zooming or application scaling is subject to change.
    Note: If you have migrated bots created in Enterprise Client 10.x version to the current version, the comparison mode that you had selected will not change to Advanced automatically. Only the bots created in the current version will have Advanced as the default mode of comparison.
  2. Normal mode: Compares the RGB components of the pixels with the source. Use this when you are not bothered about the speed and want exact color match in complex scenarios.
  3. Gray-scaled mode: Converts pixels to an appropriate level of gray-scale prior to comparing. Use this when colors are of limited benefit in comparison and you want your test to run faster.
  4. Monochrome mode with Threshold: Converts pixels to either black or white prior to comparing. The threshold value is used while converting the RGB or Gray-Scaled pixels to either black or white (a pixel value less than the threshold value is black; greater is white). Use this when you want to recognize multi-colored text against multi-colored backgrounds.
Quick Test

Use the Quick Test button to quickly ascertain the output is as required. This eliminates the need to run the entire test.

  • A Quick Test, similar to an actual test, includes the parameters provided for Match Percentage, Tolerance and Comparison Mode.
  • If variables are used in the Task Bot / MetaBot Logic, Quick Test will not be applicable.
  • For tasks created in earlier versions (prior to 7.5), Quick Test will work only after you recapture the image as this feature is available from version 7.5 onward.
  • If you get the error Unable to load DLL 'Automation.ImageAlgorithm.dll when you click Quick Test, see Enterprise 11: Windows Server Essential Media Pack configuration.
When Secure Recording Mode is enabled:
Image1 is not saved and Image2 is not captured.