npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

image-in-image

v1.0.3

Published

Package for finding an image as part of another image. In other words, picture-in-picture search.

Downloads

49

Readme

🔍 Search for image in image

With this package you can find an image as part of another image. In other words, picture-in-picture search returning position coordinates.

Image search is done while matching image pixels color and it has to be pixel perfect match. This solution is suitable for search in screenshot while looking for some part of the screen. It is not suitable for hand written digit recognition or searchng for something not exactly the same, so keep that in mind.

For a result you get x and y as a position by pixels in image from top left. Result gives you center point of found inner image in outer image.

For errors, you get { error: code, message: description }

Possible error codes and descriptions:

  • 500 - "Something went wrong, might be that images path not right"
  • 400 - "Inner bigger than outer"
  • 404 - "Image not found"

Usage

npm i image-in-image

Functions


findImage

findImage(
  outerImagePath, // your main image inside which you search
  innerImagePath, // your inner,smaller image you looking for
  outerImageMimeType // outer image type
  innerImageMimeType, // inner image type, e.g. "image/png" if .png
  //optionals
  aspectRatio, // aspect ratio, default 1, required when screenshot and screen size not the same
);

e.g.

import { findImage } from "image-in-image";

const main = async () => {
  const test = await findImage(
    "outer.png",
    "inner.png",
    "image/png",
    "image/png",
    1 // optional aspect ratio, default 1
  );
  console.log(test);
};

main();

Should return something similar:

{ "x": 268.5, "y": 161 }

findImages

import { findImages } from "image-in-image";

const main = async () => {
  const test2 = await findImages(
    "dots.png",
    "dot.png",
    "image/png",
    "image/png",
    2, // optional amount of max found, default 99
    1 // optional aspect ratio, default 1
  );
  console.log(test2);
};

main();

if findMaxAmount set to >2, returns always in array:

[
  { "x": 53, "y": 80.5 },
  { "x": 162, "y": 80.5 }
]

use Buffers instead images

import { findImages } from "image-in-image";

const main = async () => {
  const test2 = await findImages(
    BufferOfDots,
    BufferOfDot,
    "image/png",
    "image/png",
    2, // optional amount of max found, default 99
    1 // optional aspect ratio, default 1
  );
  console.log(test2);
};

main();

use Similarity option for not exact match

import { findImages } from "image-in-image";

const main = async () => {
  const test3 = await findImages(
    BufferOfDotsNotExact,
    BufferOfDot,
    "image/png",
    "image/png",
    1, // optional amount of max found, default 99
    1, // optional aspect ratio, default 1
    0.88 // optional similarity, default 1
  );
  console.log(test3);
};

main();