# usage-image-comparison

**Repository Path**: mirrors_andyglick/usage-image-comparison

## Basic Information

- **Project Name**: usage-image-comparison
- **Description**: Examples of the usage image-comparison project
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-02-11
- **Last Updated**: 2026-02-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Usage of Image-Comparison
Examples of the usage [image-comparison](https://github.com/romankh3/image-comparison) project.

# Description
The main idea is to show how to use this comparison tool.

## Dependency
It's easy to add dependency.

**Latest version is `4.1.0`**

### Maven
```xml
   <dependency>
       <groupId>com.github.romankh3</groupId>
       <artifactId>image-comparison</artifactId>
       <version>4.1.0</version>
   </dependency>
```

### Gradle
```groovy
compile 'com.github.romankh3:image-comparison:4.1.0'
```

## Code
See the example of the usage below:
```java
public class Main {

    public static void main(String[] args) {
        // load the images to be compared
        BufferedImage bufferedImage1 = ImageComparisonUtil.readImageFromResources("image1.png");
        BufferedImage bufferedImage2 = ImageComparisonUtil.readImageFromResources("image2.png");

        // where to save the result (leave null if you want to see the result in the UI)
        File resultDestination = new File( "result.png" );

        //Create ImageComparison object for it.
        ImageComparison imageComparison = new ImageComparison( bufferedImage1, bufferedImage2, resultDestination );

        //Can be used another constructor for it, without destination.
        new ImageComparison("image1.png", "image2.png");
        //or
        new ImageComparison(bufferedImage1, bufferedImage2);



        //Also can be configured BEFORE comparing next properties:

        //Threshold - it's the max distance between non-equal pixels. By default it's 5.
        imageComparison.setThreshold(10);
        imageComparison.getThreshold();

        //RectangleListWidth - Width of the line that is drawn in the rectangle. By default it's 1.
        imageComparison.setRectangleLineWidth(5);
        imageComparison.getRectangleLineWidth();

        //Destination. Before comparing also can be added destination file for result image.
        imageComparison.setDestination(resultDestination);
        imageComparison.getDestination();

        //MaximalRectangleCount - It means that would get first x biggest rectangles for drawing.
        // by default all the rectangles would be drawn.
        imageComparison.setMaximalRectangleCount(10);
        imageComparison.getMaximalRectangleCount();

        //MinimalRectangleSize - The number of the minimal rectangle size. Count as (width x height).
        // by default it's 1.
        imageComparison.setMinimalRectangleSize(100);
        imageComparison.getMinimalRectangleSize();

        //After configuring the ImageComparison object, can be executed compare() method:
        ImageComparisonResult comparisonResult = imageComparison.compareImages();

        //Can be found ComparisonState.
        ImageComparisonState comparisonState = comparisonResult.getImageComparisonState();

        //And Result Image
        BufferedImage resultImage = comparisonResult.getResult();

        //Image can be saved after comparison, using ImageComparisonUtil.
        ImageComparisonUtil.saveImage(resultDestination, resultImage);
    }
}
```

# Contribution
Feel free to create Pull-Request of the example of the usage `image-comparison` tool.