ImageDifference (Materials 0.80.0 API)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

com.kazurayam.materials.imagedifference.ImageDifference

accepts 2 BufferedImages as input, compare them, make a difference image, and calculate the ratio of difference of the 2 input images.

Properties Summary

Properties
Type	Name and description
`static org.slf4j.Logger`	`logger_`

Constructor Summary

Constructors
Constructor and description
`ImageDifference ()`
`ImageDifference (java.awt.image.BufferedImage expected, java.awt.image.BufferedImage actual)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.awt.image.BufferedImage`	`copyImage(java.awt.image.BufferedImage source)` deep copy the source BufferedImage to create a new one
	`void`	`flush()` free the memory occupied by the BufferedImages
	`java.awt.image.BufferedImage`	`getActualImage()`
	`java.awt.image.BufferedImage`	`getDiffImage()`
	`java.awt.image.BufferedImage`	`getExpectedImage()`
	`java.lang.Double`	`getRatio()` @return e.g. 0.23% or 90.0%
	`java.lang.String`	`getRatioAsString(java.lang.String fmt = '%1$.2f')` @return e.g. "0.23" or "90.00"
	`java.lang.Boolean`	`imagesAreDifferent(double criteria)` @return true if the expected image and the actual image pair has greater difference than the criteria = these are different enough, otherwise false.
	`java.lang.Boolean`	`imagesAreSimilar(double criteria)` Returns: true if the expected image and the actual image pair has smaller difference than or equal to the criteria in percentage (e.g, 5.0 means five point zero percentage); this means they are similar enough.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - static org.slf4j.Logger logger_
- Constructor Detail
  - ImageDifference()
  - ImageDifference(java.awt.image.BufferedImage expected, java.awt.image.BufferedImage actual)
- Method Detail
  - static java.awt.image.BufferedImage copyImage(java.awt.image.BufferedImage source)
    
    deep copy the source BufferedImage to create a new one
    Parameters:
    source
    Returns:
  - void flush()
    
    free the memory occupied by the BufferedImages
  - java.awt.image.BufferedImage getActualImage()
  - java.awt.image.BufferedImage getDiffImage()
  - java.awt.image.BufferedImage getExpectedImage()
  - java.lang.Double getRatio()
    
    Returns:
    e.g. 0.23% or 90.0%
  - java.lang.String getRatioAsString(java.lang.String fmt = '%1$.2f')
    
    Returns:
    e.g. "0.23" or "90.00"
  - java.lang.Boolean imagesAreDifferent(double criteria)
    
    Returns:
    true if the expected image and the actual image pair has greater difference than the criteria = these are different enough, otherwise false.
  - java.lang.Boolean imagesAreSimilar(double criteria)
    
    Returns:
    true if the expected image and the actual image pair has smaller difference than or equal to the criteria in percentage (e.g, 5.0 means five point zero percentage); this means they are similar enough. false otherwise.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation