org.openimaj.image

Class ImageUtilities

java.lang.Object

org.openimaj.image.ImageUtilities

public class ImageUtilities
extends Object

A static utility class with methods for dealing with images.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
static float[]	BYTE_TO_FLOAT_LUT Lookup table for byte->float conversion
static InputStreamObjectReader<FImage>	FIMAGE_READER An InputStreamObjectReader for reading FImages.
static InputStreamObjectReader<MBFImage>	MBFIMAGE_READER An InputStreamObjectReader for reading MBFImages.

Method Summary

Modifier and Type	Method and Description
static float[]	alphaCompositePixel(float[] p1, float[] p2) Alpha composites the pixel p1 with the pixel p2, returning the value in pixel p1
static float[]	alphaCompositePixel(Float[] p1, Float[] p2) Alpha composites the pixel p1 with the pixel p2, returning the value in pixel p1
static float[]	alphaCompositePixel(float[] out, float thisR, float thisG, float thisB, float thisA, float thatR, float thatG, float thatB, float thatA)
static <I extends Image<?,I>> I	assignBufferedImage(BufferedImage img, I oiImage) Assign the contents of a BufferedImage to an Image.
protected static boolean	checkSameSize(Image<?,?>... images) Checks whether the width and height of all the given images match.
protected static boolean	checkSize(int h, int w, Image<?,?>... images) Checks whether the width and height of all the given images match the given width and height.
protected static boolean	checkSize(int h, int w, Iterable<? extends Image<?,?>> images) Checks whether the width and height of all the given images match the given width and height.
static BufferedImage	createBufferedImage(FImage img) Efficiently create a TYPE_BYTE_GRAY for display.
static BufferedImage	createBufferedImage(FImage img, BufferedImage ret) Efficiently create a TYPE_BYTE_GRAY for display.
static BufferedImage	createBufferedImage(Image<?,?> img) Convert any image to a BufferedImage.
static BufferedImage	createBufferedImage(Image<?,?> img, BufferedImage bimg) Convert any image to a BufferedImage.
static BufferedImage	createBufferedImageForDisplay(Image<?,?> img) Convert any image to a BufferedImage.
static BufferedImage	createBufferedImageForDisplay(Image<?,?> img, BufferedImage bimg) Convert any image to a BufferedImage.
static BufferedImage	createBufferedImageForDisplay(MBFImage img) Efficiently create a TYPE_3BYTE_BGR for display if possible.
static BufferedImage	createBufferedImageForDisplay(MBFImage img, BufferedImage ret) Efficiently create a TYPE_3BYTE_BGR for display if possible.
static FImage	createFImage(BufferedImage image) Create an FImage from a buffered image.
static MBFImage	createMBFImage(BufferedImage image, boolean alpha) Create an MBFImage from a buffered image.
static BufferedImage	createWorkingImage(BufferedImage bimg) Returns a ARGB BufferedImage, even if the input BufferedImage is not ARGB format.
protected static byte[]	getBytes(File file) Returns the contents of a file in a byte array.
protected static byte[]	getBytes(InputStream stream) Converts the input stream to a byte array.
static FImage[]	getNormalisedColourPlanes(BufferedImage bimg) Calculate normalised RGB planes.
static boolean	isWriteFormatSupported(File file) Test if the image output format suggested by the extension of the given filename is supported
static boolean	isWriteFormatSupported(String fmt) Test if a given image output format name is supported
protected static int	pnmReadHeader(byte[] data, Map<String,Integer> headerData) Reads a PNM header from the byte array containing the PNM binary data.
static FImage	readF(DataInput in) Read an FImage from a DataInput
static FImage	readF(File input) Reads an FImage from the given file.
static FImage	readF(InputStream input) Reads an FImage from the given input stream.
static FImage	readF(URL input) Reads an FImage from the given URL.
static MBFImage	readMBF(File input) Reads an MBFImage from the given file.
static MBFImage	readMBF(InputStream input) Reads an MBFImage from the given input stream.
static MBFImage	readMBF(URL input) Reads an MBFImage from the given URL.
static MBFImage	readMBFAlpha(File input) Reads an MBFImage from the given file.
static MBFImage	readMBFAlpha(InputStream input) Reads an MBFImage from the given input stream.
static MBFImage	readMBFAlpha(URL input) Reads an MBFImage from the given URL.
static void	write(Image<?,?> image, File output) Write the given image to the given file, guessing the format name from the extension.
static void	write(Image<?,?> img, String formatName, DataOutput out) Write an image to a DataOutput.
static void	write(Image<?,?> image, String formatName, File output) Write the given image to the given file with the given format name.
static void	write(Image<?,?> image, String formatName, ImageOutputStream output) Write the given image to the given file with the given format name.
static void	write(Image<?,?> image, String formatName, OutputStream output) Write the given image to the given file with the given format name.

Methods inherited from class java.lang.Object

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

Field Detail

FIMAGE_READER

public static final InputStreamObjectReader<FImage> FIMAGE_READER

An InputStreamObjectReader for reading FImages.

MBFIMAGE_READER

public static final InputStreamObjectReader<MBFImage> MBFIMAGE_READER

An InputStreamObjectReader for reading MBFImages.

BYTE_TO_FLOAT_LUT

public static final float[] BYTE_TO_FLOAT_LUT

Lookup table for byte->float conversion

Method Detail

getNormalisedColourPlanes

public static FImage[] getNormalisedColourPlanes(BufferedImage bimg)

Calculate normalised RGB planes. Extracts the planes from the given RGB BufferedImage and returns an array of FImage of length 3. The images are ordered Red, Green and Blue.

Parameters:

bimg - A BufferedImage from which the planes are extracted.

Returns:

An array of FImage.

createWorkingImage

public static BufferedImage createWorkingImage(BufferedImage bimg)

Returns a ARGB BufferedImage, even if the input BufferedImage is not ARGB format.

Parameters:

bimg - The BufferedImage to normalise to ARGB

Returns:

An ARGB BufferedImage

write

public static void write(Image<?,?> image,
                         String formatName,
                         File output)
                  throws IOException

Write the given image to the given file with the given format name. Format names are the same as used by ImageIO.write(java.awt.image.RenderedImage, String, File).

Parameters:

image - The image to write.

formatName - a String containing the informal name of the format.

output - The File to write the image to.

Throws:

IOException - If the image cannot be written to the file.

write

public static void write(Image<?,?> image,
                         String formatName,
                         OutputStream output)
                  throws IOException

Write the given image to the given file with the given format name. Format names are the same as used by ImageIO.write(java.awt.image.RenderedImage, String, OutputStream) .

Parameters:

image - The image to write.

formatName - a String containing the informal name of the format.

output - The OutputStream to write the image to.

Throws:

IOException - If the image cannot be written to the file.

write

public static void write(Image<?,?> image,
                         String formatName,
                         ImageOutputStream output)
                  throws IOException

Write the given image to the given file with the given format name. Format names are the same as used by ImageIO.write(java.awt.image.RenderedImage, String, ImageOutputStream) .

Parameters:

image - The image to write.

formatName - a String containing the informal name of the format.

output - The ImageOutputStream to write the image to.

Throws:

IOException - If the image cannot be written to the file.

write

public static void write(Image<?,?> image,
                         File output)
                  throws IOException

Write the given image to the given file, guessing the format name from the extension. Format names are the same as used by ImageIO.write(java.awt.image.RenderedImage, String, File).

Parameters:

image - The image to write.

output - The File to write the image to.

Throws:

IOException - If the image cannot be written to the file.

createFImage

public static FImage createFImage(BufferedImage image)

Create an FImage from a buffered image.

Parameters:

image - the image

Returns:

an FImage representation of the input image

createMBFImage

public static MBFImage createMBFImage(BufferedImage image,
                                      boolean alpha)

Create an MBFImage from a buffered image.

Parameters:

image - the image

alpha - should the resultant MBFImage have an alpha channel

Returns:

an MBFImage representation of the input image

readF

public static FImage readF(File input)
                    throws IOException

Reads an FImage from the given file.

Parameters:

input - The file to read the FImage from.

Returns:

An FImage

Throws:

IOException - if the file cannot be read

readF

public static FImage readF(InputStream input)
                    throws IOException

Reads an FImage from the given input stream.

Parameters:

input - The input stream to read the FImage from.

Returns:

An FImage

Throws:

IOException - if the stream cannot be read

readF

public static FImage readF(URL input)
                    throws IOException

Reads an FImage from the given URL.

Parameters:

input - The URL to read the FImage from.

Returns:

An FImage

Throws:

IOException - if the URL stream cannot be read

readMBF

public static MBFImage readMBF(File input)
                        throws IOException

Reads an MBFImage from the given file.

Parameters:

input - The file to read the MBFImage from.

Returns:

An MBFImage

Throws:

IOException - if the file cannot be read

readMBF

public static MBFImage readMBF(InputStream input)
                        throws IOException

Reads an MBFImage from the given input stream.

Parameters:

input - The input stream to read the MBFImage from.

Returns:

An MBFImage

Throws:

IOException - if the stream cannot be read

readMBF

public static MBFImage readMBF(URL input)
                        throws IOException

Reads an MBFImage from the given URL.

Parameters:

input - The URL to read the MBFImage from.

Returns:

An MBFImage

Throws:

IOException - if the URL stream cannot be read

readMBFAlpha

public static MBFImage readMBFAlpha(File input)
                             throws IOException

Reads an MBFImage from the given file. The resultant MBImage will contain an alpha channel

Parameters:

input - The file to read the MBFImage from.

Returns:

An MBFImage

Throws:

IOException - if the file cannot be read

readMBFAlpha

public static MBFImage readMBFAlpha(InputStream input)
                             throws IOException

Reads an MBFImage from the given input stream. The resultant MBImage will contain an alpha channel

Parameters:

input - The input stream to read the MBFImage from.

Returns:

An MBFImage

Throws:

IOException - if the stream cannot be read

readMBFAlpha

public static MBFImage readMBFAlpha(URL input)
                             throws IOException

Reads an MBFImage from the given URL. The resultant MBImage will contain an alpha channel

Parameters:

input - The URL to read the MBFImage from.

Returns:

An MBFImage

Throws:

IOException - if the URL stream cannot be read

checkSameSize

protected static boolean checkSameSize(Image<?,?>... images)

Checks whether the width and height of all the given images match.

Parameters:

images - The images to compare sizes.

Returns:

TRUE if all the images are the same size; FALSE otherwise

checkSize

protected static boolean checkSize(int h,
                                   int w,
                                   Image<?,?>... images)

Checks whether the width and height of all the given images match the given width and height.

Parameters:

h - The height to match against all the images

w - The width to match against all the images

images - The images to compare sizes.

Returns:

TRUE if all the images are wxh in size; FALSE otherwise

checkSize

protected static boolean checkSize(int h,
                                   int w,
                                   Iterable<? extends Image<?,?>> images)

Checks whether the width and height of all the given images match the given width and height.

Parameters:

h - The height to match against all the images

w - The width to match against all the images

images - The images to compare sizes.

Returns:

TRUE if all the images are wxh in size; FALSE otherwise

pnmReadHeader

protected static int pnmReadHeader(byte[] data,
                                   Map<String,Integer> headerData)
                            throws IOException

Reads a PNM header from the byte array containing the PNM binary data. The headerData variable will be populated with the header information. Returns the number of bytes read from the array.

Parameters:

data - The PNM binary data.

headerData - A Map to populate with header information.

Returns:

The number of bytes read from the array.

Throws:

IOException - if the byte array does not contain PNM information.

getBytes

protected static byte[] getBytes(File file)
                          throws IOException

Returns the contents of a file in a byte array.

Parameters:

file - The file to read

Returns:

A byte array representation of the file.

Throws:

IOException - if the file cannot be read fully.

getBytes

protected static byte[] getBytes(InputStream stream)
                          throws IOException

Converts the input stream to a byte array. The input stream is fully read.

Parameters:

stream - The InputStream to convert to byte array

Returns:

A byte array representation of the InputStream data.

Throws:

IOException - if the input stream cannot be fully read.

createBufferedImage

public static BufferedImage createBufferedImage(Image<?,?> img)

Convert any image to a BufferedImage.

Parameters:

img - image to convert

Returns:

BufferedImage representation

createBufferedImage

public static BufferedImage createBufferedImage(Image<?,?> img,
                                                BufferedImage bimg)

Convert any image to a BufferedImage.

Parameters:

img - image to convert

bimg - BufferedImage to draw into if possible. Can be null.

Returns:

BufferedImage representation

createBufferedImageForDisplay

public static BufferedImage createBufferedImageForDisplay(Image<?,?> img)

Convert any image to a BufferedImage.

Parameters:

img - image to convert

Returns:

BufferedImage representation

createBufferedImageForDisplay

public static BufferedImage createBufferedImageForDisplay(Image<?,?> img,
                                                          BufferedImage bimg)

Convert any image to a BufferedImage.

Parameters:

img - image to convert

bimg - BufferedImage to draw into if possible. Can be null.

Returns:

BufferedImage representation

createBufferedImageForDisplay

public static BufferedImage createBufferedImageForDisplay(MBFImage img)

Efficiently create a TYPE_3BYTE_BGR for display if possible. This is typically much faster than to create and display than an ARGB buffered image. If the input image is not in RGB format, then the ARGB form will be returned instead.

Parameters:

img - the image to convert

Returns:

the converted image

createBufferedImageForDisplay

public static BufferedImage createBufferedImageForDisplay(MBFImage img,
                                                          BufferedImage ret)

Efficiently create a TYPE_3BYTE_BGR for display if possible. This is typically much faster than to create and display than an ARGB buffered image. If the input image is not in RGB format, then the ARGB form will be returned instead.

Parameters:

img - the image to convert

ret - the image to draw into if possible. Can be null.

Returns:

the converted image. Might not be the same as the ret parameter.

createBufferedImage

public static BufferedImage createBufferedImage(FImage img)

Efficiently create a TYPE_BYTE_GRAY for display. This is typically much faster than to create and display than an ARGB buffered image.

Parameters:

img - the image to convert

Returns:

the converted image

createBufferedImage

public static BufferedImage createBufferedImage(FImage img,
                                                BufferedImage ret)

Efficiently create a TYPE_BYTE_GRAY for display. This is typically much faster than to create and display than an ARGB buffered image.

Parameters:

img - the image to convert

ret - BufferedImage to draw into if possible. Can be null.

Returns:

the converted image

write

public static void write(Image<?,?> img,
                         String formatName,
                         DataOutput out)
                  throws IOException

Write an image to a DataOutput.

Parameters:

img - the image

formatName - the format

out - the output

Throws:

IOException - if an error occurs

readF

public static FImage readF(DataInput in)
                    throws IOException

Read an FImage from a DataInput

Parameters:

in - input

Returns:

new FImage

Throws:

IOException - if error occurs

assignBufferedImage

public static <I extends Image<?,I>> I assignBufferedImage(BufferedImage img,
                                                           I oiImage)

Assign the contents of a BufferedImage to an Image.

Type Parameters:

I - the type of Image

Parameters:

img - the BufferedImage to copy

oiImage - the Image to fill

Returns:

the given input image.

alphaCompositePixel

public static float[] alphaCompositePixel(float[] p1,
                                          float[] p2)

Alpha composites the pixel p1 with the pixel p2, returning the value in pixel p1

Parameters:

p1 - The first pixel

p2 - The second pixel

Returns:

The updates first pixel p1

alphaCompositePixel

public static float[] alphaCompositePixel(float[] out,
                                          float thisR,
                                          float thisG,
                                          float thisB,
                                          float thisA,
                                          float thatR,
                                          float thatG,
                                          float thatB,
                                          float thatA)

Parameters:

out - where the write the composition

thisR -

thisG -

thisB -

thisA -

thatR -

thatG -

thatB -

thatA -

Returns:

returns out

alphaCompositePixel

public static float[] alphaCompositePixel(Float[] p1,
                                          Float[] p2)

Alpha composites the pixel p1 with the pixel p2, returning the value in pixel p1

Parameters:

p1 - The first pixel

p2 - The second pixel

Returns:

The updates first pixel p1

isWriteFormatSupported

public static boolean isWriteFormatSupported(String fmt)

Test if a given image output format name is supported

Parameters:

fmt - the format name

Returns:

true if supported; false otherwise

isWriteFormatSupported

public static boolean isWriteFormatSupported(File file)

Test if the image output format suggested by the extension of the given filename is supported

Parameters:

file - the file

Returns:

true if supported; false otherwise