https://github.com/0x0m0r1/spigel

Image comparison/hashing library
https://github.com/0x0m0r1/spigel

Last synced: 12 days ago
JSON representation

Image comparison/hashing library

• Host: GitHub
• URL: https://github.com/0x0m0r1/spigel
• Owner: song-juo
• Created: 2022-03-30T19:02:59.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-23T02:26:39.000Z (over 1 year ago)
• Last Synced: 2024-05-16T08:14:35.250Z (6 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.12 MB
• Stars: 21
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-blazingly-fast - dhash - Blazing fast image comparison/hashing tool for Node (JavaScript)

README

        











**Fast** node library which implements many hashing algorithms and media manipulation bindings into a *friendly API* which **discards the use of ML (Machine Learning)** for image semelliance level classsification trough the use of pure math.

📒 ***[Check our Documentation!](https://spigel.gsant.org/)***

### Give it a try 🌸

```bash

npm i spigel

```

### 🖼️ It's simple as:

```ts

import { compare } from 'spigel';

async function someFunction() {

const result = await compare('./example.png', './example2.png', { humanize: true });

// => { distance: 'different', hash: { hashA: '...', hashB: '...' } }

}

```

### 📝 ToDo List - Please, contribute!

- [x] Implement Dhash (Difference Hash)

- [x] Cleanup code & comments

- [x] Publish first release to GitHub

- [x] Make it able to be posted in NPM

- [x] Publish first release to NPM

- [x] Full Typescript conversion

- [x] Ensure support for cross-comparisons between strings and buffers

- [x] Implement pHash (Perceptual Hash)

- [x] Modernize our code's structure

	- [x] Function to Class structure conversion

	- [x] Convert algorithm functions to classes

	- [x] Assert typings to algorithms

	- [x] Humanize comparison results

- [x] Write a detailed documentation

- [x] First hikaku's major release

- [x] Project's name changed from "Hikaku" to "Spigel"