at.mug.iqm.commons.util.image

Class ImageTools

java.lang.Object

at.mug.iqm.commons.util.image.ImageTools

public final class ImageTools
extends Object

Author:

Philipp Kainz

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.log4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
ImageTools()

Method Summary

Modifier and Type	Method and Description
static javax.media.jai.PlanarImage	combineChannels(javax.media.jai.PlanarImage pi, List<Integer> bands) Combines the specified channels (bands) from a given image to a single band grey value image.
static javax.media.jai.PlanarImage	copyCustomImageProperties(javax.media.jai.PlanarImage source, javax.media.jai.PlanarImage destination) Copies the image properties image_name file_name model_name from the source to the destination object.
static String	createB64EncodedToolTipImg(javax.media.jai.PlanarImage image, int targetWidth, int targetHeight) Creates a base64 encoded string for the data URI of an image to be used in an HTML tag.
static Thumbnail	createManagerThumb(javax.media.jai.PlanarImage pi) Generate a 40-by-40 pixel thumb nail of a given image.
static Thumbnail	createTankThumb(javax.media.jai.PlanarImage pi) Generate a 60-by-60 pixel thumb nail of a given image for the Tank list.
static ImageIcon	createThumbnail(javax.media.jai.PlanarImage image, int targetWidth, int targetHeight, boolean keepAspectRatio, boolean withBorder) This static method returns an image icon of a given PlanarImage.
static javax.media.jai.PlanarImage	extractBlackChannel(javax.media.jai.PlanarImage pi) Extracts an entirely black channel of the size of a given image.
static javax.media.jai.PlanarImage	extractChannel(javax.media.jai.PlanarImage pi, int band) Extracts a specified channel (band) from a given image.
static javax.media.jai.PlanarImage	extractChannels(javax.media.jai.PlanarImage pi, List<Integer> bands) Extracts a specified channels (bands) from a given image and produces a multi-banded image.
static double[]	getCenterOfGravity(javax.media.jai.PlanarImage pi) This method calculates the center of gravity The center coordinates refer to the upper left corner
static String	getImgType(javax.media.jai.PlanarImage pi) This static method gets the image type
static double	getImgTypeGreyMax(javax.media.jai.PlanarImage pi) This method gets the maximal possible grey value depending on the image type
static int	getRasterSample(Raster r, int x, int y, int band) This method returns a raster sample from within the Raster's bounding rectangle.
static void	main(String[] args)
static javax.media.jai.PlanarImage	paintROIsOnImage(javax.media.jai.PlanarImage image, List<IDrawingLayer> layers) Superimposes a set of regions of interest on an underlying image.
static javax.media.jai.PlanarImage	removeAlphaChannel(javax.media.jai.PlanarImage image) Removes the alpha channel, if any present and returns the image with the number of original color bands.
static Raster	removeAlphaChannel(Raster raster) Removes the alpha channel, if any present and returns the raster with the number of original color bands.
static javax.media.jai.PlanarImage	scale(javax.media.jai.PlanarImage image, int targetWidth, int targetHeight) Scales a given image to a specified size.
static javax.media.jai.PlanarImage	scaleKeepAspectRatio(javax.media.jai.PlanarImage image, int targetSize) Scales a given image to a target size by keeping the aspect ratio.
static void	showImage(BufferedImage image, String title) Displays the BufferedImage in a separate JFrame.
static BufferedImage	toBufferedImage(RenderedImage img)
static byte[]	toByteArray(javax.media.jai.PlanarImage image, String encoding) Creates a base64 encoded string for the data URI of an image to be used in an HTML tag.
static RenderedImage	toCompatibleImage(RenderedImage input) Draws the input image to a compatible format for the current local GraphicsEnvironment.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.apache.log4j.Logger logger

Constructor Detail

ImageTools

public ImageTools()

Method Detail

copyCustomImageProperties

public static javax.media.jai.PlanarImage copyCustomImageProperties(javax.media.jai.PlanarImage source,
                                                                    javax.media.jai.PlanarImage destination)

Copies the image properties

• image_name
• file_name
• model_name

from the source to the destination object.

Parameters:

source -

destination -

Returns:

a planar image with copied properties

getCenterOfGravity

public static double[] getCenterOfGravity(javax.media.jai.PlanarImage pi)

This method calculates the center of gravity The center coordinates refer to the upper left corner

getRasterSample

public static int getRasterSample(Raster r,
                                  int x,
                                  int y,
                                  int band)

This method returns a raster sample from within the Raster's bounding rectangle.

Parameters:

r -

x -

y -

band -

Returns:

raster sample

getImgType

public static String getImgType(javax.media.jai.PlanarImage pi)

This static method gets the image type

Parameters:

pi - - PlanarImage instance

Returns:

image type as String

getImgTypeGreyMax

public static double getImgTypeGreyMax(javax.media.jai.PlanarImage pi)

This method gets the maximal possible grey value depending on the image type

createTankThumb

public static Thumbnail createTankThumb(javax.media.jai.PlanarImage pi)

Generate a 60-by-60 pixel thumb nail of a given image for the Tank list.

Parameters:

pi - an image

Returns:

an image icon for the tank list, scaled to fit 60x60 px

createManagerThumb

public static Thumbnail createManagerThumb(javax.media.jai.PlanarImage pi)

Generate a 40-by-40 pixel thumb nail of a given image.

Parameters:

pi - the image to be scaled

Returns:

ImageIcon

createThumbnail

public static ImageIcon createThumbnail(javax.media.jai.PlanarImage image,
                                        int targetWidth,
                                        int targetHeight,
                                        boolean keepAspectRatio,
                                        boolean withBorder)

This static method returns an image icon of a given PlanarImage.

Parameters:

image - the image to be scaled

targetWidth - the target width of the thumb nail

targetHeight - the target height of the thumb nail (only used if keepAspectRatio is false)

keepAspectRatio - whether or not the value given in targetWidth should be used as longest edge

withBorder - whether or not a grey border should be painted around the scaled image

Returns:

ImageIcon

createB64EncodedToolTipImg

public static String createB64EncodedToolTipImg(javax.media.jai.PlanarImage image,
                                                int targetWidth,
                                                int targetHeight)

Creates a base64 encoded string for the data URI of an image to be used in an HTML tag.

Parameters:

image - the image

targetWidth - the target width

targetHeight - the target height

Returns:

a base64 encoded String

scaleKeepAspectRatio

public static javax.media.jai.PlanarImage scaleKeepAspectRatio(javax.media.jai.PlanarImage image,
                                                               int targetSize)

Scales a given image to a target size by keeping the aspect ratio.

Parameters:

image -

targetSize -

Returns:

scale

public static javax.media.jai.PlanarImage scale(javax.media.jai.PlanarImage image,
                                                int targetWidth,
                                                int targetHeight)

Scales a given image to a specified size.

Parameters:

image - the original image

targetWidth - the target width

targetHeight - the target height

Returns:

the scaled image

showImage

public static void showImage(BufferedImage image,
                             String title)

Displays the BufferedImage in a separate JFrame.

Parameters:

image -

toByteArray

public static byte[] toByteArray(javax.media.jai.PlanarImage image,
                                 String encoding)

Creates a base64 encoded string for the data URI of an image to be used in an HTML tag.

Parameters:

image - the image

encoding - the encoding string for ImageIO.write(java.awt.image.RenderedImage, String, java.io.OutputStream)

Returns:

a byte[]

main

public static void main(String[] args)

removeAlphaChannel

public static javax.media.jai.PlanarImage removeAlphaChannel(javax.media.jai.PlanarImage image)

Removes the alpha channel, if any present and returns the image with the number of original color bands.

If the image does not have an alpha channel, it is returned unchanged.

Parameters:

image -

Returns:

a planar image with alpha channel removed

Throws:

IllegalArgumentException - if the image is null

removeAlphaChannel

public static Raster removeAlphaChannel(Raster raster)

Removes the alpha channel, if any present and returns the raster with the number of original color bands.

If the raster does not have an alpha channel, it is returned unchanged.

Parameters:

raster -

Returns:

a planar image with alpha channel removed

Throws:

IllegalArgumentException - if the image is null

extractChannel

public static javax.media.jai.PlanarImage extractChannel(javax.media.jai.PlanarImage pi,
                                                         int band)

Extracts a specified channel (band) from a given image.

Parameters:

pi - the source image

band - the band to be extracted

Returns:

an image with a single band

Throws:

IllegalArgumentException - if pi is null, band<0, or band> pi.getNumBands()

extractBlackChannel

public static javax.media.jai.PlanarImage extractBlackChannel(javax.media.jai.PlanarImage pi)

Extracts an entirely black channel of the size of a given image.

Parameters:

pi - the source image

Returns:

a black image with a single band

Throws:

IllegalArgumentException - if pi is null

combineChannels

public static javax.media.jai.PlanarImage combineChannels(javax.media.jai.PlanarImage pi,
                                                          List<Integer> bands)

Combines the specified channels (bands) from a given image to a single band grey value image.

Parameters:

pi - the source image

bands - the ordered list of bands to be extracted

Returns:

an image with a single band

Throws:

IllegalArgumentException - if pi is null, bands.size()==0, or bands.get(i)>pi.getNumBands()

extractChannels

public static javax.media.jai.PlanarImage extractChannels(javax.media.jai.PlanarImage pi,
                                                          List<Integer> bands)

Extracts a specified channels (bands) from a given image and produces a multi-banded image.

Parameters:

pi - the source image

bands - the ordered list of bands to be extracted

Returns:

an image with a single band

Throws:

IllegalArgumentException - if pi is null, bands.size()==0, or bands.get(i)>pi.getNumBands()

toBufferedImage

public static BufferedImage toBufferedImage(RenderedImage img)

toCompatibleImage

public static RenderedImage toCompatibleImage(RenderedImage input)

Draws the input image to a compatible format for the current local GraphicsEnvironment.

Parameters:

input - the image

Returns:

the input, if the image is already compatible, the converted image otherwise

paintROIsOnImage

public static javax.media.jai.PlanarImage paintROIsOnImage(javax.media.jai.PlanarImage image,
                                                           List<IDrawingLayer> layers)

Superimposes a set of regions of interest on an underlying image.

Parameters:

image -

layers -

Returns:

an image with the ROIs drawn