# simimgrs

[![CircleCI](https://circleci.com/gh/po3rin/simimgrs.svg?style=shield)](https://circleci.com/gh/po3rin/simimgrs) [![Crate](https://img.shields.io/crates/v/simimgrs.svg)](https://crates.io/crates/simimgrs) [![API](https://docs.rs/simimgrs/badge.svg)](https://docs.rs/simimgrs)

-----

## What is

<img src="./testdata/similar.png" width="460px">

Are these similar images ? yes !!
this crate checks for similar image using average hash algorism. The average of the luminance values ​​is calculated, and the 64-bit hash value is calculated as “1” for greater than the average and “0” for less than the average.

## Quick Start

```rust
use image;
use simimgrs;

fn main() {
    let img1 = image::open("testdata/go1.jpg").unwrap();
    let img2 = image::open("testdata/go2.jpg").unwrap();

    let checker = simimgrs::SimilarChecker::new().threshold(10).compression_size(8, 8);

    println!("similar image: {}", checker.is_similar(img1, img2)) // true !
}
```

## As CLI

```bash
$ cargo install simimgrs
$ simimgrs testdata/go1.jpg testdata/go2.jpg
similar image: true
```

## Dependencies

https://github.com/image-rs/image