Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use ComparisonResult class of io.appium.java_client.imagecomparison package

Best io.appium code snippet using io.appium.java_client.imagecomparison.ComparisonResult

ComparisonResult.java

Source:ComparisonResult.java

...24import java.io.IOException;25import java.io.OutputStream;26import java.nio.charset.StandardCharsets;27import java.util.Map;28public abstract class ComparisonResult {29    private static final String VISUALIZATION = "visualization";30    @Getter(AccessLevel.PROTECTED) private final Map<String, Object> commandResult;31    public ComparisonResult(Map<String, Object> commandResult) {32        this.commandResult = commandResult;33    }34    /**35     * Verifies if the corresponding property is present in the commend result36     * and throws an exception if not.37     *38     * @param propertyName the actual property name to be verified for presence39     */40    protected void verifyPropertyPresence(String propertyName) {41        if (!commandResult.containsKey(propertyName)) {42            throw new IllegalStateException(43                    String.format("There is no '%s' attribute in the resulting command output %s. "44                            + "Did you set the options properly?", propertyName, commandResult));45        }...

FeaturesMatchingResult.java

Source:FeaturesMatchingResult.java

...18import org.openqa.selenium.Rectangle;19import java.util.List;20import java.util.Map;21import java.util.stream.Collectors;22public class FeaturesMatchingResult extends ComparisonResult {23    private static final String COUNT = "count";24    private static final String TOTAL_COUNT = "totalCount";25    private static final String POINTS1 = "points1";26    private static final String RECT1 = "rect1";27    private static final String POINTS2 = "points2";28    private static final String RECT2 = "rect2";29    public FeaturesMatchingResult(Map<String, Object> input) {30        super(input);31    }32    /**33     * Returns a count of matched edges on both images.34     *35     * @return The count of matched edges on both images.36     *     The more matching edges there are no both images the more similar they are.37     */38    public int getCount() {39        verifyPropertyPresence(COUNT);40        return ((Long) getCommandResult().get(COUNT)).intValue();41    }42    /**43     * Returns a count of matched edges on both images.44     *45     * @return The total count of matched edges on both images.46     *     It is equal to `count` if `goodMatchesFactor` does not limit the matches,47     *     otherwise it contains the total count of matches before `goodMatchesFactor` is48     *     applied.49     */50    public int getTotalCount() {51        verifyPropertyPresence(TOTAL_COUNT);52        return ((Long) getCommandResult().get(TOTAL_COUNT)).intValue();53    }54    /**55     * Returns a list of matching points on the first image.56     *57     * @return The list of matching points on the first image.58     */59    public List<Point> getPoints1() {60        verifyPropertyPresence(POINTS1);61        //noinspection unchecked62        return ((List<Map<String, Object>>) getCommandResult().get(POINTS1)).stream()63                .map(ComparisonResult::mapToPoint)64                .collect(Collectors.toList());65    }66    /**67     * Returns a rect for the `points1` list.68     *69     * @return The bounding rect for the `points1` list or a zero rect if not enough matching points were found.70     */71    public Rectangle getRect1() {72        verifyPropertyPresence(RECT1);73        //noinspection unchecked74        return mapToRect((Map<String, Object>) getCommandResult().get(RECT1));75    }76    /**77     * Returns a list of matching points on the second image.78     *79     * @return The list of matching points on the second image.80     */81    public List<Point> getPoints2() {82        verifyPropertyPresence(POINTS2);83        //noinspection unchecked84        return ((List<Map<String, Object>>) getCommandResult().get(POINTS2)).stream()85                .map(ComparisonResult::mapToPoint)86                .collect(Collectors.toList());87    }88    /**89     * Returns a rect for the `points2` list.90     *91     * @return The bounding rect for the `points2` list or a zero rect if not enough matching points were found.92     */93    public Rectangle getRect2() {94        verifyPropertyPresence(RECT2);95        //noinspection unchecked96        return mapToRect((Map<String, Object>) getCommandResult().get(RECT2));97    }98}...

SimilarityMatchingResult.java

Source:SimilarityMatchingResult.java

...14 * limitations under the License.15 */16package io.appium.java_client.imagecomparison;17import java.util.Map;18public class SimilarityMatchingResult extends ComparisonResult {19    private static final String SCORE = "score";20    public SimilarityMatchingResult(Map<String, Object> input) {21        super(input);22    }23    /**24     * Returns the similarity score as a float number in range [0.0, 1.0].25     *26     * @return The similarity score as a float number in range [0.0, 1.0].27     *     1.0 is the highest score (means both images are totally equal).28     */29    public double getScore() {30        verifyPropertyPresence(SCORE);31        //noinspection unchecked32        if (getCommandResult().get(SCORE) instanceof Long) {...

OccurrenceMatchingResult.java

Source:OccurrenceMatchingResult.java

...15 */16package io.appium.java_client.imagecomparison;17import org.openqa.selenium.Rectangle;18import java.util.Map;19public class OccurrenceMatchingResult extends ComparisonResult {20    private static final String RECT = "rect";21    public OccurrenceMatchingResult(Map<String, Object> input) {22        super(input);23    }24    /**25     * Returns rectangle of partial image occurrence.26     *27     * @return The region of the partial image occurrence on the full image.28     */29    public Rectangle getRect() {30        verifyPropertyPresence(RECT);31        //noinspection unchecked32        return mapToRect((Map<String, Object>) getCommandResult().get(RECT));33    }...

ComparisonResult

Using AI Code Generation

1import io.appium.java_client.imagecomparison.ComparisonResult;2import io.appium.java_client.imagecomparison.OccurrenceMatchingOptions;3import io.appium.java_client.imagecomparison.OccurrenceMatchingResult;4import io.appium.java_client.imagecomparison.OccurrenceMatchingSettings;5import io.appium.java_client.imagecomparison.SimilarityMatchingOptions;6import io.appium.java_client.imagecomparison.SimilarityMatchingResult;7import io.appium.java_client.imagecomparison.SimilarityMatchingSettings;8import io.appium.java_client.imagecomparison.TemplateMatchingOptions;9import io.appium.java_client.imagecomparison.TemplateMatchingResult;10import io.appium.java_client.imagecomparison.TemplateMatchingSettings;11import io.appium.java_client.imagecomparison.VisualLocatorSettings;12import io.appium.java_client.imagecomparison.VisualLocatorStrategy;13import io.appium.java_client.imagecomparison.VisualLocatorType;14import io.appium.java_client.imagecomparison.VisualTextSettings;15import io.appium.java_client.imagecomparison.VisualTextType;16public class ImageComparisonTest {17    public static void main(String[] args) throws MalformedURLException {18        DesiredCapabilities caps = new DesiredCapabilities();19        caps.setCapability("deviceName", "Pixel 3a API 28");20        caps.setCapability("platformName", "Android");21        caps.setCapability("appPackage", "io.appium.android.apis");22        caps.setCapability("appActivity", ".ApiDemos");23        caps.setCapability("automationName", "UiAutomator2");24        driver.manage().timeouts().implicitlyWait(10, TimeUnit.SECONDS);25        driver.findElementByAccessibilityId("Graphics").click();26        driver.findElementByAccessibilityId("Arcs").click();27        MobileElement element = driver.findElementByAccessibilityId("Graphics/Arcs");28        File file = element.getScreenshotAs(OutputType.FILE);29        File image = new File("C:\\Users\\admin\\Desktop\\appium\\appium\\images\\image.png");30        VisualLocatorSettings visualLocatorSettings = new VisualLocatorSettings();31        visualLocatorSettings.setStrategy(VisualLocatorStrategy.SIMILARITY);32        visualLocatorSettings.setType(VisualLocatorType.IMAGE);33        visualLocatorSettings.setThreshold(.8);34        TemplateMatchingSettings templateMatchingSettings = new TemplateMatchingSettings();

ComparisonResult

Using AI Code Generation

1import io.appium.java_client.imagecomparison.ComparisonResult;2import io.appium.java_client.imagecomparison.OccurrenceMatchingOptions;3import io.appium.java_client.imagecomparison.OccurrenceMatchingResult;4import io.appium.java_client.imagecomparison.SimilarityMatchingOptions;5import io.appium.java_client.imagecomparison.SimilarityMatchingResult;6import io.appium.java_client.imagecomparison.features.FeaturesMatchingOptions;7import io.appium.java_client.imagecomparison.features.FeaturesMatchingResult;8public class AppiumTest {9public static void main(String[] args) {10	ComparisonResult result = new ComparisonResult();11	System.out.println(result.getConfidence());12	System.out.println(result.getMatchedPoints());13	System.out.println(result.getMatchedTemplate());14	System.out.println(result.getRect());15	System.out.println(result.getScore());16	System.out.println(result.getSimilarity());17	System.out.println(result.toString());18	OccurrenceMatchingOptions options = new OccurrenceMatchingOptions();19	options.withEnabledVisualization();20	options.withMaxMatches(10);21	options.withMinScore(0.8);22	options.withThreshold(0.9);23	System.out.println(options.getEnabledVisualization());24	System.out.println(options.getMaxMatches());25	System.out.println(options.getMinScore());26	System.out.println(options.getThreshold());27	System.out.println(options.toString());28	OccurrenceMatchingResult matchingResult = new OccurrenceMatchingResult();29	matchingResult.setConfidence(0.8);30	matchingResult.setMatchedPoints(10);31	matchingResult.setMatchedTemplate(20);32	matchingResult.setRect(30);33	matchingResult.setScore(40);34	matchingResult.setSimilarity(50);35	System.out.println(matchingResult.getConfidence());36	System.out.println(matchingResult.getMatchedPoints());37	System.out.println(matchingResult.getMatchedTemplate());38	System.out.println(matchingResult.getRect());39	System.out.println(matchingResult.getScore());40	System.out.println(matchingResult.getSimilarity());41	System.out.println(matchingResult.toString());42	SimilarityMatchingOptions similarityOptions = new SimilarityMatchingOptions();43	similarityOptions.withEnabledVisualization();

ComparisonResult

Using AI Code Generation

1import io.appium.java_client.imagecomparison.ComparisonResult;2import io.appium.java_client.imagecomparison.FeatureMatchingOptions;3import io.appium.java_client.imagecomparison.FeatureMatchingOptions;4import io.appium.java_client.imagecomparison.OccurrenceMatchingOptions;5import java.io.File;6import java.time.Duration;7import org.openqa.selenium.remote.DesiredCapabilities;8import org.testng.annotations.AfterTest;9import org.testng.annotations.BeforeTest;10import org.testng.annotations.Test;11import io.appium.java_client.MobileElement;12import io.appium.java_client.android.AndroidDriver;13import io.appium.java_client.android.AndroidElement;14import io.appium.java_client.android.AndroidTouchAction;15import io.appium.java_client.android.nativekey.AndroidKey;16import io.appium.java_client.android.nativekey.KeyEvent;17import io.appium.java_client.touch.LongPressOptions;18import io.appium.java_client.touch.WaitOptions;19import io.appium.java_client.touch.offset.ElementOption;20import static io.appium.java_client.touch.TapOptions.tapOptions;21import static io.appium.java_client.touch.offset.ElementOption.element;22import static io.appium.java_client.touch.LongPressOptions.longPressOptions;23import static io.appium.java_client.touch.offset.ElementOption.element;24import static java.time.Duration.ofSeconds;25public class Appium {26public static AndroidDriver<AndroidElement> driver;27public void setUp() throws Exception {28DesiredCapabilities capabilities = new DesiredCapabilities();29capabilities.setCapability("deviceName", "emulator-5554");30capabilities.setCapability("platformName", "Android");31capabilities.setCapability("platformVersion", "10.0");32capabilities.setCapability("appPackage", "com.android.calculator2");33capabilities.setCapability("appActivity", "com.android.calculator2.Calculator");

ComparisonResult

Using AI Code Generation

1package appium;2import io.appium.java_client.imagecomparison.ComparisonResult;3import io.appium.java_client.AppiumDriver;4import org.openqa.selenium.remote.DesiredCapabilities;5import io.appium.java_client.MobileElement;6import org.openqa.selenium.By;7import java.net.URL;8import java.net.MalformedURLException;9import java.io.IOException;10public class Appium {11    public static void main(String[] args) throws InterruptedException, IOException {12        DesiredCapabilities capabilities = new DesiredCapabilities();13        capabilities.setCapability("deviceName", "emulator-5554");14        capabilities.setCapability("BROWSER_NAME", "Android");15        capabilities.setCapability("VERSION", "8.0.0");16        capabilities.setCapability("platformName", "Android");17        capabilities.setCapability("appPackage", "com.android.calculator2");18        capabilities.setCapability("appActivity", "com.android.calculator2.Calculator");19        AppiumDriver driver = null;20        try {21            driver = new AppiumDriver(new URL("http

ComparisonResult

Using AI Code Generation

1import io.appium.java_client.imagecomparison.ComparisonResult;2ComparisonResult result = driver.getImagesSimilarity(image1, image2);3result.getScore();4result.getMatchedPercentage();5result.getRectangles();6result.getVisualization();7const { ComparisonResult } = require('appium/java_client/imagecomparison');8const result = await driver.getImagesSimilarity(image1, image2);9result.getScore();10result.getMatchedPercentage();11result.getRectangles();12result.getVisualization();13from appium.java_client.imagecomparison import ComparisonResult14result = driver.get_images_similarity(image1, image2)15result.get_score()16result.get_matched_percentage()17result.get_rectangles()18result.get_visualization()19result = driver.get_images_similarity(image1, image2)20result.get_score()21result.get_matched_percentage()22result.get_rectangles()23result.get_visualization()24use Appium\Java_client\Imagecomparison\ComparisonResult;25$result = $driver->get_images_similarity($image1, $image2);26$result->get_score();27$result->get_matched_percentage();28$result->get_rectangles();29$result->get_visualization();30library(appium.java_client.imagecomparison.ComparisonResult)31result = driver$get_images_similarity(image1, image2)32result$get_score()

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.