ImageHash

<h1 align="center"> <img src="https://raw.githubusercontent.com/coenm/ImageHash/master/icon/ImageHash.512.png" alt="ImageHash" width="256"/> <br/> ImageHash </h1> <div align="center">

</div> .NET Standard library containing multiple algorithms to calculate perceptual hashes of images and to calculate similarity using those hashes. <!-- toc -->

Contents

• Perceptual hash
• Hash Algorithms
• Credits
• API
  • Calculate image hash
  • Calculate image similarity
• Some screenshots of the demo application<!-- endToc -->

Perceptual hash

Definition by phash.org

A perceptual hash is a fingerprint of a multimedia file derived from various features from its content. Unlike cryptographic hash functions which rely on the avalanche effect of small changes in input leading to drastic changes in the output, perceptual hashes are "close" to one another if the features are similar.

Hash Algorithms

This project implements the following algorithms:

• AverageHash by Dr. Neal Krawetz. Check his blog/article here;
• PerceptualHash also by Dr. Neal Krawetz.
• DifferenceHash by David Oftedal with minor improvements of Dr. Neal Krawetz. More information can be found here or here.

Credits

• This project uses the ImageSharp library for image processing;
• Also based on existing implementations of already listed algorithms: jenssegers/imagehash and jforshee/ImageHashing;
• Icon created by Rik.

API

Calculate image hash

<!-- snippet: CalculateImageHash -->

<a id='snippet-CalculateImageHash'></a>

var hashAlgorithm = new AverageHash();
// or one of the other available algorithms:
// var hashAlgorithm = new DifferenceHash();
// var hashAlgorithm = new PerceptualHash();

string filename = "your filename";
using var stream = File.OpenRead(filename);

ulong imageHash = hashAlgorithm.Hash(stream);

^{<a href='/tests/ImageHash.Test/Examples.cs#L14-L26' title='Snippet source file'>snippet source</a> | <a href='#snippet-CalculateImageHash' title='Start of snippet'>anchor</a>}

<!-- endSnippet -->

Calculate image similarity

Note that to calculate the image similarity, both image hashes should have been calculated using the same hash algorihm.

<!-- snippet: CalculateSimilarity -->

<a id='snippet-CalculateSimilarity'></a>

// calculate the two image hashes
ulong hash1 = hashAlgorithm.Hash(imageStream1);
ulong hash2 = hashAlgorithm.Hash(imageStream2);

double percentageImageSimilarity = CompareHash.Similarity(hash1, hash2);

^{<a href='/tests/ImageHash.Test/Examples.cs#L35-L43' title='Snippet source file'>snippet source</a> | <a href='#snippet-CalculateSimilarity' title='Start of snippet'>anchor</a>}

<!-- endSnippet -->

You can also take a look at DotNet APIs.

Some screenshots of the demo application