com.applitools.utils

Class ImageUtils

java.lang.Object

com.applitools.utils.ImageUtils

public class ImageUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
ImageUtils()

Method Summary

Modifier and Type	Method and Description
static String	base64FromImage(BufferedImage image)
static BufferedImage	copyImageWithType(BufferedImage src, int updatedType) Creates a copy of an image with an updated image type.
static byte[]	encodeAsPng(BufferedImage image) Encodes a given image as PNG.
static BufferedImage	getImagePart(BufferedImage image, Region region) Get a copy of the part of the image given by region.
static BufferedImage	imageFromBase64(String image64) Creates a BufferedImage instance from a base64 encoding of an image's bytes.
static BufferedImage	imageFromBytes(byte[] imageBytes) Creates a BufferedImage instance from raw image bytes.
static BufferedImage	imageFromFile(String path)
static BufferedImage	imageFromResource(String resource)
static BufferedImage	rotateImage(BufferedImage image, double deg)
static BufferedImage	scaleImage(BufferedImage image, ScaleMethod scaleMethod, double scaleRatio) Scales an image by the given ratio

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageUtils

public ImageUtils()

Method Detail

encodeAsPng

public static byte[] encodeAsPng(BufferedImage image)

Encodes a given image as PNG.

Parameters:

image - The image to encode.

Returns:

The PNG bytes representation of the image.

imageFromFile

public static BufferedImage imageFromFile(String path)
                                   throws EyesException

Throws:

EyesException

imageFromResource

public static BufferedImage imageFromResource(String resource)
                                       throws EyesException

Throws:

EyesException

imageFromBase64

public static BufferedImage imageFromBase64(String image64)
                                     throws EyesException

Creates a BufferedImage instance from a base64 encoding of an image's bytes.

Parameters:

image64 - The base64 encoding of an image's bytes.

Returns:

A BufferedImage instance.

Throws:

EyesException - If there was a problem creating the BufferedImage instance.

base64FromImage

public static String base64FromImage(BufferedImage image)

Parameters:

image - The image from which to get its base64 representation.

Returns:

The base64 representation of the image (bytes encoded as PNG).

imageFromBytes

public static BufferedImage imageFromBytes(byte[] imageBytes)
                                    throws EyesException

Creates a BufferedImage instance from raw image bytes.

Parameters:

imageBytes - The raw bytes of the image.

Returns:

A BufferedImage instance representing the image.

Throws:

EyesException - If there was a problem creating the BufferedImage instance.

getImagePart

public static BufferedImage getImagePart(BufferedImage image,
                                         Region region)

Get a copy of the part of the image given by region.

Parameters:

image - The image from which to get the part.

region - The region which should be copied from the image.

Returns:

The part of the image.

rotateImage

public static BufferedImage rotateImage(BufferedImage image,
                                        double deg)

copyImageWithType

public static BufferedImage copyImageWithType(BufferedImage src,
                                              int updatedType)

Creates a copy of an image with an updated image type.

Parameters:

src - The image to copy.

updatedType - The type of the copied image. See BufferedImage.getType().

Returns:

A copy of the src of the requested type.

scaleImage

public static BufferedImage scaleImage(BufferedImage image,
                                       ScaleMethod scaleMethod,
                                       double scaleRatio)

Scales an image by the given ratio

Parameters:

image - The image to scale.

scaleMethod - The method used in order to scale the image.

scaleRatio - The ratio by which to scale the image.

Returns:

If the scale ratio != 1, returns a new scaled image, otherwise, returns the original image.