jerryshell / similars

similaRS is a tool for calculating image similarity. Written in Rust.

similaRS

similaRS is a tool for calculating image similarity. Written in Rust.

Usage

USAGE:
    similars_cli [OPTIONS] --image-x-path <IMAGE_X_PATH> --image-y-path <IMAGE_Y_PATH>

OPTIONS:
        --clean-flag
            If --clean-flag is explicitly specified, images in the wrong format will be deleted
            automatically

    -d, --distance-flag
            By default, the output is a percentile of similarity, and if --distance-flag is
            explicitly specified, the output is hamming distance.

        --debug-flag


    -h, --hamming-height <HAMMING_HEIGHT>
            [default: 8]

        --help
            Print help information

    -V, --version
            Print version information

    -w, --hamming-width <HAMMING_WIDTH>
            [default: 8]

    -x, --image-x-path <IMAGE_X_PATH>


    -y, --image-y-path <IMAGE_Y_PATH>

Example

By default, the output is a percentile of similarity.

$ ./similars_cli -x example_img1.jpg -y example_img2.jpg
95.3125

If -d is explicitly specified, the output is hamming distance.

$ ./similars_cli -d -x example_img1.jpg -y example_img2.jpg
3

References

• https://www.ruanyifeng.com/blog/2011/07/principle_of_similar_image_search.html

License

GNU Affero General Public License v3.0