org.mapfish.print.test.util

Class ImageSimilarity

java.lang.Object

org.mapfish.print.test.util.ImageSimilarity

public final class ImageSimilarity
extends java.lang.Object

Class for comparing an image to another image.

Constructor Summary

Constructors

Constructor and Description
ImageSimilarity(java.awt.image.BufferedImage referenceImage, int sampleSize)
ImageSimilarity(java.io.File referenceImage, int sampleSize) The constructor, which creates the GUI and start the image processing task.

Method Summary

Methods

Modifier and Type	Method and Description
void	assertSimilarity(java.io.File other, double maxDistance) Check that the other image and the image calculated by this object are within the given distance.
static java.awt.image.BufferedImage	convertFromSvg(java.net.URI svgFile, int width, int height) Renders an SVG image into a BufferedImage.
static void	exportReportToFile(net.sf.jasperreports.engine.JasperPrint jasperPrint, java.lang.String fileName, java.lang.Integer page) Exports a rendered JasperPrint to a graphics file.
static java.awt.image.BufferedImage	exportReportToImage(net.sf.jasperreports.engine.JasperPrint jasperPrint, java.lang.Integer page) Exports a rendered JasperPrint to a BufferedImage.
static void	main(java.lang.String[] args)
static java.awt.image.BufferedImage	mergeImages(java.util.List<java.net.URI> graphicFiles, int width, int height) Merges a list of graphic files into a single graphic.
static void	writeUncompressedImage(java.awt.image.BufferedImage image, java.lang.String file) Write the image to a file in uncompressed tiff format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageSimilarity

public ImageSimilarity(java.io.File referenceImage,
               int sampleSize)
                throws java.io.IOException

The constructor, which creates the GUI and start the image processing task.

Throws:

java.io.IOException

ImageSimilarity

public ImageSimilarity(java.awt.image.BufferedImage referenceImage,
               int sampleSize)
                throws java.io.IOException

Throws:

java.io.IOException

Method Detail

assertSimilarity

public void assertSimilarity(java.io.File other,
                    double maxDistance)
                      throws java.io.IOException

Check that the other image and the image calculated by this object are within the given distance.

Parameters:

other - the image to compare to "this" image.

maxDistance - the maximum distance between the two images.

Throws:

java.io.IOException

writeUncompressedImage

public static void writeUncompressedImage(java.awt.image.BufferedImage image,
                          java.lang.String file)
                                   throws java.io.IOException

Write the image to a file in uncompressed tiff format.

Parameters:

image - image to write

file - path and file name (extension will be ignored and changed to tiff.

Throws:

java.io.IOException

mergeImages

public static java.awt.image.BufferedImage mergeImages(java.util.List<java.net.URI> graphicFiles,
                                       int width,
                                       int height)
                                                throws java.io.IOException,
                                                       org.apache.batik.transcoder.TranscoderException

Merges a list of graphic files into a single graphic.

Parameters:

graphicFiles - a list of graphic files

width - the graphic width (required for svg files)

height - the graphic height (required for svg files)

Returns:

a single graphic

Throws:

org.apache.batik.transcoder.TranscoderException

java.io.IOException

convertFromSvg

public static java.awt.image.BufferedImage convertFromSvg(java.net.URI svgFile,
                                          int width,
                                          int height)
                                                   throws org.apache.batik.transcoder.TranscoderException

Renders an SVG image into a BufferedImage.

Throws:

org.apache.batik.transcoder.TranscoderException

exportReportToImage

public static java.awt.image.BufferedImage exportReportToImage(net.sf.jasperreports.engine.JasperPrint jasperPrint,
                                               java.lang.Integer page)
                                                        throws java.lang.Exception

Exports a rendered JasperPrint to a BufferedImage.

Throws:

java.lang.Exception

exportReportToFile

public static void exportReportToFile(net.sf.jasperreports.engine.JasperPrint jasperPrint,
                      java.lang.String fileName,
                      java.lang.Integer page)
                               throws java.lang.Exception

Exports a rendered JasperPrint to a graphics file.

Throws:

java.lang.Exception

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Throws:

java.io.IOException