com.github.hypfvieh.imaging.ImgAHash Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-utils Show documentation

A collection of utils commonly used in my projects. Feel free to use it (or parts of it) in your own projects.

The newest version!

package com.github.hypfvieh.imaging;

import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;

import javax.imageio.ImageIO;

/**
 * Class which implements AHash (average hash) algorithm to create hashes of images.
 *
 * @author hypfvieh
 * @since 1.0.6 - 2018-10-09
 */
public class ImgAHash extends AbstractImgHash {

    private static final ImgAHash INSTANCE = new ImgAHash();

    private ImgAHash() {

    }

    /**
     * Compute the AHash of the given file (which should be a valid image).
     *
     * @param _image image to hash
     * @return hash as string
     * @throws IOException on any error when reading file
     */
    public static String computeHash(File _image) throws IOException {
        BufferedImage bufferedImage = ImageIO.read(_image);
        BufferedImage resizedImage = INSTANCE.resizeAndGrayScale(8, 8, bufferedImage);

        int[] d = INSTANCE.createPixelArray(resizedImage);

        String s = INSTANCE.hash(d);
        return s;
    }

    /**
     * Calculate the mean of the pixel array.
     * @param _pixelArray pixel array
     * @return mean
     */
    private double calcMean(int[] _pixelArray) {
        double sum = 0;
        for (int i = 0; i < _pixelArray.length; i++) {
            sum += _pixelArray[i];
        }
        return sum / _pixelArray.length;
    }

    /**
     * Read the given pixel array and convert it to a hash.

     * First the pixel array is converted to a boolean array (bitMask).

     * Every true value in the array is calculated by comparing the pixel against

     * the next pixel (neighbor). If the current pixel is smaller than the next, true is set.

     * 

     * After that, the boolean array is converted to a long and returned as hex-string
     *
     * @param _pixelArray pixel array
     * @return hex string
     */
    private String hash(int[] _pixelArray) {

        boolean[] bitMask = new boolean[_pixelArray.length-1];

        double mean = calcMean(_pixelArray);

        for (int i = 0; i < _pixelArray.length - 1; i++) {
            if (_pixelArray[i] > mean) {
                bitMask[i] = true;
            }
        }

        return bitmaskToHex(bitMask, 16);
    }


}