Skip to content

OrrishLabs/image-compare

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Orrish Image Compare

Plain Java library to compare two images.

It compares two same sized images and can return diff statistics. It can also save the diff file with differences shown in the configured colors. This has been tested with png and JPG images.

Usage

Maven

Add the repository in pom.xml.

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

Include it as dependency like this

<dependency>
    <groupId>com.github.OrrishLabs</groupId>
    <artifactId>image-compare</artifactId>
    <version>0.0.3</version>
</dependency>
Usage example
        // Simplest way
        CompareResult compareResultSimple = new CompareImage()
        .setBaselineFile("expected.png")
        .setActualFile("actual.png")
        .setSaveDiffFile(false)
        .compare();

        // Detailed way
        CompareResult compareResultDetailed = new CompareImage()
        .setBaselineFile("expected.png")
        .setActualFile("actual.png")
        .setDiffFile("diff.png")
        .setSaveDiffFile(true)
        .setDiffColor(Color.RED)
        .setIgnoreRegion(0, 0, 1000, 500)
        .setMaxDiffPixels(90)
        .setDiffThreshold(2)
        .compare();

        compareResultDetailed.isSameWithIgnoreArea();
        // Similarly, use other results from CompareResult

About

Compares two images and returns difference.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages