Image-based automation settings specify how Ranorex Studio detects and identifies UI elements based on image data. You can configure these settings globally for all new actions or individually for specific validation actions.
Image-based settings
To set up the default values for image-based recording, open the Settings dialog and go to the Imaging tab.
Default image find and validation options
These options control the default reporting values for image-based searches and validations like ContainsImage and CompareImage.
- Return the best match (and not the first one): If you select this option, Ranorex uses the position with the highest similarity for validation. Otherwise, Ranorex uses the first available match. Using the best match is more accurate, while using the first match is faster.
- Similarity threshold (0.0-1.0): Specifies the minimum similarity (0.0-1.0) required for an image region to be considered a match.
- Downsize quality (0-100): Controls how strong or gentle the Downsize processing is when Ranorex scales images down. The goal of downsizing is to reduce the number of pixels while keeping unique characteristics of the image.
- Preprocessing steps: Defines the steps performed on an image before a search. Options include Downsize, Edges, EdgesSobel, Grayscale, and Threshold.
- Timeout (ms): Sets the maximum time Ranorex searches for the image match.
- Report difference image: Determines if and when the report includes an image showing the differences between the expected and actual images. The default is Never.
- Report screenshot: Determines if and when the report includes a screenshot of the validated UI element. The default is Never.
- Report similarity: Determines if and when the report includes the similarity between the expected and actual images. The default is Never.
- Report expected and actual images: Determines if and when the report includes both the expected and actual images. The default is On Fail.
See also: Image-Based Properties for more information about the similarity threshold and the preprocessing steps.
Image-based properties
You can override default settings for a specific action by using the Properties pane. These changes only affect the selected action.
- Select an action in the recording table.
- Press F4 to open the Properties pane.
- See the Image-based properties section.
These properties include the same configuration options as the image-based settings dialog.
- Preprocessing settings
- Similarity factor to determine the similarity threshold.
See also: Image-Based Approach for more information.