How to use getImagesSimilarity method of io.appium.java_client.ComparesImages class

...1650				"findImageOccurrence", myClasses, currentDriver.mainDriver.getClass().toString(), myTrueParam );1651	}1652	1653	// ********************************************************************************************************************************************************1654	// AndroidDriver		   [113] = public default io.appium.java_client.imagecomparison.SimilarityMatchingResult io.appium.java_client.ComparesImages.getImagesSimilarity(java.io.File, java.io.File ) throws java.io.IOException1655	1656	// ********************************************************************************************************************************************************1657	// AndroidDriver		   [114] = public default io.appium.java_client.imagecomparison.SimilarityMatchingResult io.appium.java_client.ComparesImages.getImagesSimilarity(java.io.File, java.io.File, io.appium.java_client.imagecomparison.SimilarityMatchingOptions ) throws java.io.IOException1658	1659	// ********************************************************************************************************************************************************1660	// AndroidDriver		   [115] = public default io.appium.java_client.imagecomparison.SimilarityMatchingResult io.appium.java_client.ComparesImages.getImagesSimilarity(byte[], byte[], io.appium.java_client.imagecomparison.SimilarityMatchingOptions )1661	1662	// ********************************************************************************************************************************************************1663	// AndroidDriver		   [116] = public default io.appium.java_client.imagecomparison.SimilarityMatchingResult io.appium.java_client.ComparesImages.getImagesSimilarity(byte[], byte[] )1664	1665	// ********************************************************************************************************************************************************1666	// AndroidDriver		   [117] = public default void io.appium.java_client.android.nativekey.PressesKey.pressKeyCode(int)1667	public void pressKeyCode( int key ) {1668		pureDriverDetails currentDriver = getCurrentDriverDetails();1669		pureCore.callMethod( currentDriver.mainDriver, currentDriver.mainDriver.getClass(), "pressKeyCode",1670				java.lang.String.class, currentDriver.mainDriver.getClass().toString(), key );1671	}1672	// ********************************************************************************************************************************************************1673	// AndroidDriver		   [118] = public default void io.appium.java_client.android.nativekey.PressesKey.pressKeyCode(int,java.lang.Integer)1674	1675	// ********************************************************************************************************************************************************1676	// AndroidDriver		   [119] = public default void io.appium.java_client.android.nativekey.PressesKey.pressKey(io.appium.java_client.android.nativekey.KeyEvent)1677	public void pressKey( io.appium.java_client.android.nativekey.KeyEvent keyEvent ) {...

...155     * @param base64image1 base64-encoded representation of the first image156     * @param base64Image2 base64-encoded representation of the second image157     * @return Matching result. The configuration of fields in the result depends on comparison options.158     */159    default SimilarityMatchingResult getImagesSimilarity(byte[] base64image1, byte[] base64Image2) {160        return getImagesSimilarity(base64image1, base64Image2, null);161    }162    /**163     * Performs images matching to calculate the similarity score between them.164     * The flow there is similar to the one used in165     * {@link #findImageOccurrence(byte[], byte[], OccurrenceMatchingOptions)},166     * but it is mandatory that both images are of equal size.167     *168     * @param base64image1 base64-encoded representation of the first image169     * @param base64Image2 base64-encoded representation of the second image170     * @param options comparison options171     * @return Matching result. The configuration of fields in the result depends on comparison options.172     */173    default SimilarityMatchingResult getImagesSimilarity(byte[] base64image1, byte[] base64Image2,174                                                         @Nullable SimilarityMatchingOptions options) {175        Object response = CommandExecutionHelper.execute(this,176                compareImagesCommand(ComparisonMode.GET_SIMILARITY, base64image1, base64Image2, options));177        //noinspection unchecked178        return new SimilarityMatchingResult((Map<String, Object>) response);179    }180    /**181     * Performs images matching to calculate the similarity score between them182     * with default options. The flow there is similar to the one used in183     * {@link #findImageOccurrence(byte[], byte[], OccurrenceMatchingOptions)},184     * but it is mandatory that both images are of equal size.185     *186     * @param image1 The location of the full image187     * @param image2 The location of the partial image188     * @return Matching result. The configuration of fields in the result depends on comparison options.189     */190    default SimilarityMatchingResult getImagesSimilarity(File image1, File image2) throws IOException {191        return getImagesSimilarity(image1, image2, null);192    }193    /**194     * Performs images matching to calculate the similarity score between them.195     * The flow there is similar to the one used in196     * {@link #findImageOccurrence(byte[], byte[], OccurrenceMatchingOptions)},197     * but it is mandatory that both images are of equal size.198     *199     * @param image1 The location of the full image200     * @param image2 The location of the partial image201     * @param options comparison options202     * @return Matching result. The configuration of fields in the result depends on comparison options.203     */204    default SimilarityMatchingResult getImagesSimilarity(File image1, File image2,205                                                         @Nullable SimilarityMatchingOptions options)206            throws IOException {207        return getImagesSimilarity(Base64.encodeBase64(FileUtils.readFileToByteArray(image1)),208                Base64.encodeBase64(FileUtils.readFileToByteArray(image2)), options);209    }210}...

...167    }168    /**169     * Compares two valid java bitmaps and calculates similarity score between them.170     * Both images are expected to be of the same size/resolution. The method171     * implicitly invokes {@link ComparesImages#getImagesSimilarity(byte[], byte[])}.172     *173     * @param refImage   reference image174     * @param tplImage   template175     * @return similarity score value in range (-1.0, 1.0]. 1.0 is returned if the images are equal176     * @throws ScreenshotComparisonError if provided images are not valid or have177     *                                   different resolution178     */179    public double getOverlapScore(BufferedImage refImage, BufferedImage tplImage) {180        try (ByteArrayOutputStream img1 = new ByteArrayOutputStream();181             ByteArrayOutputStream img2 = new ByteArrayOutputStream()) {182            ImageIO.write(refImage, "png", img1);183            ImageIO.write(tplImage, "png", img2);184            return comparator185                    .getImagesSimilarity(Base64.getEncoder().encode(img1.toByteArray()),186                            Base64.getEncoder().encode(img2.toByteArray()))187                    .getScore();188        } catch (IOException e) {189            throw new ScreenshotComparisonError(e);190        }191    }192}...

1package appium;2import java.io.File;3import java.net.URL;4import org.openqa.selenium.remote.DesiredCapabilities;5import io.appium.java_client.MobileElement;6import io.appium.java_client.android.AndroidDriver;7import io.appium.java_client.android.AndroidElement;8import io.appium.java_client.comparesimage.ImageComparisonResult;9import io.appium.java_client.remote.MobileCapabilityType;10public class GetImagesSimilarity {11	public static void main(String[] args) throws Exception {12		DesiredCapabilities cap = new DesiredCapabilities();13		cap.setCapability(MobileCapabilityType.PLATFORM_NAME, "Android");14		cap.setCapability(MobileCapabilityType.PLATFORM_VERSION, "8.0.0");15		cap.setCapability(MobileCapabilityType.DEVICE_NAME, "emulator-5554");16		cap.setCapability(MobileCapabilityType.APP, "C:\\Users\\Srinivas\\Downloads\\ApiDemos-debug.apk");

1package appium;2import java.io.File;3import java.io.IOException;4import java.net.MalformedURLException;5import java.net.URL;6import org.openqa.selenium.remote.DesiredCapabilities;7import io.appium.java_client.android.AndroidDriver;8import io.appium.java_client.android.AndroidElement;9import io.appium.java_client.remote.MobileCapabilityType;10import io.appium.java_client.service.local.AppiumDriverLocalService;11import io.appium.java_client.service.local.AppiumServiceBuilder;12import io.appium.java_client.service.local.flags.GeneralServerFlag;13import io.appium.java_client.ComparesImages;14public class Appium {15    public static void main(String[] args) throws MalformedURLException, IOException, InterruptedException {16        AppiumServiceBuilder builder = new AppiumServiceBuilder();17        builder.withIPAddress("

1import io.appium.java_client.ComparesImages;2import io.appium.java_client.MobileElement;3import io.appium.java_client.android.AndroidDriver;4import org.openqa.selenium.remote.DesiredCapabilities;5import java.net.URL;6import java.net.MalformedURLException;7import java.util.concurrent.TimeUnit;8import org.testng.annotations.AfterClass;9import org.testng.annotations.BeforeClass;10import org.testng.annotations.Test;11import org.testng.Assert;12public class GetImagesSimilarity {13    private String reportDirectory = "reports";14    private String reportFormat = "xml";15    private String testName = "GetImagesSimilarity";16    protected AndroidDriver<MobileElement> driver = null;17    DesiredCapabilities dc = new DesiredCapabilities();18    public void setUp() throws MalformedURLException {19        dc.setCapability("reportDirectory", reportDirectory);20        dc.setCapability("reportFormat", reportFormat);21        dc.setCapability("testName", testName);22        dc.setCapability("deviceName", "Android");23        dc.setCapability("platformName", "Android");24        driver.manage().timeouts().implicitlyWait(10, TimeUnit.SECONDS);25    }26    public void testGetImagesSimilarity() {27        double similarity = driver.getImagesSimilarity("C:\\Users\\user1\\Desktop\\image1.png", "C:\\Users\\user1\\Desktop\\image2.png");28        System.out.println("Similarity of two images : " + similarity);29        Assert.assertEquals(similarity, 0.90);30    }31    public void tearDown() {32        driver.quit();33    }34}35from appium import webdriver36from appium.webdriver.common.touch_action import TouchAction37import unittest38import os39class GetImagesSimilarity(unittest.TestCase):40    def setUp(self):41        desired_caps = {}42    def test_get_images_similarity(self):