public class

ImageUtil

extends Object
java.lang.Object
   ↳ com.sun.imageio.plugins.common.ImageUtil

Summary

Public Constructors
ImageUtil()
Public Methods
final static void canEncodeImage(ImageWriter writer, ColorModel colorModel, SampleModel sampleModel)
Checks that the provided ImageWriter can encode the provided ColorModel and SampleModel.
final static void canEncodeImage(ImageWriter writer, ImageTypeSpecifier type)
Checks that the provided ImageWriter can encode the provided ImageTypeSpecifier or not.
static String convertObjectToString(Object obj)
Converts the provided object to String
static ColorModel createColorModel(ColorSpace colorSpace, SampleModel sampleModel)
final static ColorModel createColorModel(SampleModel sampleModel)
Creates a ColorModel that may be used with the specified SampleModel.
static long getBandSize(SampleModel sm)
static int getElementSize(SampleModel sm)
static byte[] getPackedBinaryData(Raster raster, Rectangle rect)
For the case of binary data (isBinary() returns true), return the binary data as a packed byte array.
static long getTileSize(SampleModel sm)
static byte[] getUnpackedBinaryData(Raster raster, Rectangle rect)
Returns the binary data unpacked into an array of bytes.
final static boolean imageIsContiguous(RenderedImage image)
Returns whether the image has contiguous data across rows.
static boolean isBinary(SampleModel sm)
static boolean isIndicesForGrayscale(byte[] r, byte[] g, byte[] b)
Tests whether the color indices represent a gray-scale image.
static void setPackedBinaryData(byte[] binaryDataArray, WritableRaster raster, Rectangle rect)
Sets the supplied Raster's data from an array of packed binary data of the form returned by getPackedBinaryData().
static void setUnpackedBinaryData(byte[] bdata, WritableRaster raster, Rectangle rect)
Copies data into the packed array of the Raster from an array of unpacked data of the form returned by getUnpackedBinaryData().
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ImageUtil ()

Public Methods

public static final void canEncodeImage (ImageWriter writer, ColorModel colorModel, SampleModel sampleModel)

Checks that the provided ImageWriter can encode the provided ColorModel and SampleModel. If not, an IIOException will be thrown.

Parameters
writer The provided ImageWriter.
colorModel The provided ColorModel.
sampleModel The provided SampleModel.
Throws
IIOException If the writer cannot encoded the provided image.

public static final void canEncodeImage (ImageWriter writer, ImageTypeSpecifier type)

Checks that the provided ImageWriter can encode the provided ImageTypeSpecifier or not. If not, an IIOException will be thrown.

Parameters
writer The provided ImageWriter.
type The image to be tested.
Throws
IIOException If the writer cannot encoded the provided image.

public static String convertObjectToString (Object obj)

Converts the provided object to String

public static ColorModel createColorModel (ColorSpace colorSpace, SampleModel sampleModel)

public static final ColorModel createColorModel (SampleModel sampleModel)

Creates a ColorModel that may be used with the specified SampleModel. If a suitable ColorModel cannot be found, this method returns null.

Suitable ColorModels are guaranteed to exist for all instances of ComponentSampleModel. For 1- and 3- banded SampleModels, the returned ColorModel will be opaque. For 2- and 4-banded SampleModels, the output will use alpha transparency which is not premultiplied. 1- and 2-banded data will use a grayscale ColorSpace, and 3- and 4-banded data a sRGB ColorSpace. Data with 5 or more bands will have a BogusColorSpace.

An instance of DirectColorModel will be created for instances of SinglePixelPackedSampleModel with no more than 4 bands.

An instance of IndexColorModel will be created for instances of MultiPixelPackedSampleModel. The colormap will be a grayscale ramp with 1 << numberOfBits entries ranging from zero to at most 255.

Returns
  • An instance of ColorModel that is suitable for the supplied SampleModel, or null.
Throws
IllegalArgumentException If sampleModel is null.

public static long getBandSize (SampleModel sm)

public static int getElementSize (SampleModel sm)

public static byte[] getPackedBinaryData (Raster raster, Rectangle rect)

For the case of binary data (isBinary() returns true), return the binary data as a packed byte array. The data will be packed as eight bits per byte with no bit offset, i.e., the first bit in each image line will be the left-most of the first byte of the line. The line stride in bytes will be (int)((getWidth()+7)/8). The length of the returned array will be the line stride multiplied by getHeight()

Returns
  • the binary data as a packed array of bytes with zero offset of null if the data are not binary.
Throws
IllegalArgumentException if isBinary() returns false with the SampleModel of the supplied Raster as argument.

public static long getTileSize (SampleModel sm)

public static byte[] getUnpackedBinaryData (Raster raster, Rectangle rect)

Returns the binary data unpacked into an array of bytes. The line stride will be the width of the Raster.

Throws
IllegalArgumentException if isBinary() returns false with the SampleModel of the supplied Raster as argument.

public static final boolean imageIsContiguous (RenderedImage image)

Returns whether the image has contiguous data across rows.

public static boolean isBinary (SampleModel sm)

public static boolean isIndicesForGrayscale (byte[] r, byte[] g, byte[] b)

Tests whether the color indices represent a gray-scale image.

Parameters
r The red channel color indices.
g The green channel color indices.
b The blue channel color indices.
Returns
  • If all the indices have 256 entries, and are identical mappings, return true; otherwise, return false.

public static void setPackedBinaryData (byte[] binaryDataArray, WritableRaster raster, Rectangle rect)

Sets the supplied Raster's data from an array of packed binary data of the form returned by getPackedBinaryData().

Throws
IllegalArgumentException if isBinary() returns false with the SampleModel of the supplied Raster as argument.

public static void setUnpackedBinaryData (byte[] bdata, WritableRaster raster, Rectangle rect)

Copies data into the packed array of the Raster from an array of unpacked data of the form returned by getUnpackedBinaryData().

If the data are binary, then the target bit will be set if and only if the corresponding byte is non-zero.

Throws
IllegalArgumentException if isBinary() returns false with the SampleModel of the supplied Raster as argument.