OpenCV-related helper library
npm install @appium/opencv> OpenCV-related helper methods


npm install @appium/opencv
Loads the opencv bindings. You only need to explicitly call this if you want to use your own opencv
methods that are not included in this module.
``js`
import {initOpenCv} from '@appium/opencv';
await initOpenCv();
Calculates the count of common edges between two images. The images might be rotated or resized
relatively to each other. See the function definition for more details.
`js
import {getImagesMatches} from '@appium/opencv';
import {fs} from '@appium/support';
const image1 = await fs.readFile('image1.jpg')
const image2 = await fs.readFile('image2.jpg')
const {points1, rect1, points2, rect2, totalCount, count} = await getImagesMatches(image1, image2);
`
Calculates the similarity score between two images. It is expected that both images have the same
resolution. See the function definition for more details.
`js
import {getImagesSimilarity} from '@appium/opencv';
import {fs} from '@appium/support';
const image1 = await fs.readFile('image1.jpg')
const image2 = await fs.readFile('image2.jpg')
const {score} = await getImagesSimilarity(image1, image2);
`
Calculates the occurrence position of a partial image in the full image. See the function definition
for more details.
`js
import {getImageOccurrence} from '@appium/opencv';
import {fs} from '@appium/support';
const fullImage = await fs.readFile('image1.jpg')
const partialImage = await fs.readFile('image2.jpg')
const {rect, score} = await getImageOccurrence(fullImage, partialImage);
``
Apache-2.0