Package com.github.romankh3.image.comparison

Class ImageComparison

java.lang.Object

com.github.romankh3.image.comparison.ImageComparison

public class ImageComparison
extends java.lang.Object

Main class for comparison images.

Constructor Summary

Constructors

Constructor	Description
ImageComparison(java.awt.image.BufferedImage expected, java.awt.image.BufferedImage actual)	Create a new instance of ImageComparison that can compare the given images.
ImageComparison(java.awt.image.BufferedImage expected, java.awt.image.BufferedImage actual, java.io.File destination)	Create a new instance of ImageComparison that can compare the given images.
ImageComparison(java.lang.String expected, java.lang.String actual)	Create a new instance of ImageComparison that can compare the given images.

Method Summary

Modifier and Type	Method	Description
ImageComparisonResult	compareImages()	Draw rectangles which cover the regions of the difference pixels.
java.util.List<Rectangle>	createMask()	Returns the list of rectangles that would be drawn as a diff image.
java.awt.image.BufferedImage	getActual()
double	getAllowingPercentOfDifferentPixels()
java.util.Optional<java.io.File>	getDestination()
java.awt.Color	getDifferenceRectangleColor()
java.awt.Color	getExcludedRectangleColor()
java.awt.image.BufferedImage	getExpected()
java.lang.Integer	getMaximalRectangleCount()
java.lang.Integer	getMinimalRectangleSize()
double	getPercentOpacityDifferenceRectangles()
double	getPercentOpacityExcludedRectangles()
double	getPixelToleranceLevel()
int	getRectangleLineWidth()
int	getThreshold()
boolean	isDrawExcludedRectangles()
boolean	isFillDifferenceRectangles()
boolean	isFillExcludedRectangles()
ImageComparison	setAllowingPercentOfDifferentPixels(double allowingPercentOfDifferentPixels)
ImageComparison	setDestination(java.io.File destination)
ImageComparison	setDifferenceRectangleColor(java.awt.Color differenceRectangleColor)
ImageComparison	setDifferenceRectangleFilling(boolean fillRectangles, double percentOpacity)
ImageComparison	setDrawExcludedRectangles(boolean drawExcludedRectangles)
ImageComparison	setExcludedAreas(java.util.List<Rectangle> excludedAreas)
ImageComparison	setExcludedRectangleColor(java.awt.Color excludedRectangleColor)
ImageComparison	setExcludedRectangleFilling(boolean fillRectangles, double percentOpacity)
ImageComparison	setMaximalRectangleCount(java.lang.Integer maximalRectangleCount)
ImageComparison	setMinimalRectangleSize(java.lang.Integer minimalRectangleSize)
ImageComparison	setPixelToleranceLevel(double pixelToleranceLevel)
ImageComparison	setRectangleLineWidth(int rectangleLineWidth)
ImageComparison	setThreshold(int threshold)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageComparison

public ImageComparison(java.lang.String expected,
                       java.lang.String actual)

Create a new instance of ImageComparison that can compare the given images.

Parameters:

expected - expected image to be compared

actual - actual image to be compared

ImageComparison

public ImageComparison(java.awt.image.BufferedImage expected,
                       java.awt.image.BufferedImage actual,
                       java.io.File destination)

Create a new instance of ImageComparison that can compare the given images.

Parameters:

expected - expected image to be compared

actual - actual image to be compared

destination - destination to save the result. If null, the result is shown in the UI.

ImageComparison

public ImageComparison(java.awt.image.BufferedImage expected,
                       java.awt.image.BufferedImage actual)

Create a new instance of ImageComparison that can compare the given images.

Parameters:

expected - expected image to be compared

actual - actual image to be compared

Method Detail

compareImages

public ImageComparisonResult compareImages()

Draw rectangles which cover the regions of the difference pixels.

Returns:

the result of the drawing.

createMask

public java.util.List<Rectangle> createMask()

Returns the list of rectangles that would be drawn as a diff image. If you submit two images that are the same barring the parts you want to excludedAreas you get a list of rectangles that can be used as said excludedAreas

Returns:

List of Rectangle

getPixelToleranceLevel

public double getPixelToleranceLevel()

setPixelToleranceLevel

public ImageComparison setPixelToleranceLevel(double pixelToleranceLevel)

isDrawExcludedRectangles

public boolean isDrawExcludedRectangles()

setDrawExcludedRectangles

public ImageComparison setDrawExcludedRectangles(boolean drawExcludedRectangles)

getThreshold

public int getThreshold()

setThreshold

public ImageComparison setThreshold(int threshold)

getDestination

public java.util.Optional<java.io.File> getDestination()

setDestination

public ImageComparison setDestination(java.io.File destination)

getExpected

public java.awt.image.BufferedImage getExpected()

getActual

public java.awt.image.BufferedImage getActual()

getRectangleLineWidth

public int getRectangleLineWidth()

setRectangleLineWidth

public ImageComparison setRectangleLineWidth(int rectangleLineWidth)

getMinimalRectangleSize

public java.lang.Integer getMinimalRectangleSize()

setMinimalRectangleSize

public ImageComparison setMinimalRectangleSize(java.lang.Integer minimalRectangleSize)

getMaximalRectangleCount

public java.lang.Integer getMaximalRectangleCount()

setMaximalRectangleCount

public ImageComparison setMaximalRectangleCount(java.lang.Integer maximalRectangleCount)

setExcludedAreas

public ImageComparison setExcludedAreas(java.util.List<Rectangle> excludedAreas)

isFillDifferenceRectangles

public boolean isFillDifferenceRectangles()

getPercentOpacityDifferenceRectangles

public double getPercentOpacityDifferenceRectangles()

setDifferenceRectangleFilling

public ImageComparison setDifferenceRectangleFilling(boolean fillRectangles,
                                                     double percentOpacity)

isFillExcludedRectangles

public boolean isFillExcludedRectangles()

getPercentOpacityExcludedRectangles

public double getPercentOpacityExcludedRectangles()

setExcludedRectangleFilling

public ImageComparison setExcludedRectangleFilling(boolean fillRectangles,
                                                   double percentOpacity)

getAllowingPercentOfDifferentPixels

public double getAllowingPercentOfDifferentPixels()

setAllowingPercentOfDifferentPixels

public ImageComparison setAllowingPercentOfDifferentPixels(double allowingPercentOfDifferentPixels)

getDifferenceRectangleColor

public java.awt.Color getDifferenceRectangleColor()

setDifferenceRectangleColor

public ImageComparison setDifferenceRectangleColor(java.awt.Color differenceRectangleColor)

getExcludedRectangleColor

public java.awt.Color getExcludedRectangleColor()

setExcludedRectangleColor

public ImageComparison setExcludedRectangleColor(java.awt.Color excludedRectangleColor)