ImageUtil (SCIFIO Javadocs 0-SNAPSHOT API)

java.lang.Object
- io.scif.media.imageioimpl.common.ImageUtil

```
public class ImageUtil
extends Object
```

Constructor Summary

Constructors
Constructor and Description

ImageUtil()

Constructors
Constructor and Description
`ImageUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`canEncodeImage(ImageWriter writer, ColorModel colorModel, SampleModel sampleModel)` Checks that the provided `ImageWriter` can encode the provided `ColorModel` and `SampleModel`.
`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)`
`static ColorModel`	`createColorModel(SampleModel sampleModel)` Creates a `ColorModel` that may be used with the specified `SampleModel`.
`static long`	`getBandSize(SampleModel sm)`
`static ImageTypeSpecifier`	`getDestinationType(ImageReadParam param, Iterator imageTypes)` Gets the destination image type.
`static int`	`getElementSize(SampleModel sm)`
`static List`	`getJDKImageReaderWriterSPI(ServiceRegistry registry, String formatName, boolean isReader)`
`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.
`static boolean`	`imageIsContiguous(RenderedImage image)` Returns whether the image has contiguous data across rows.
`static boolean`	`isBinary(SampleModel sm)`
`static boolean`	`isGrayscaleMapping(IndexColorModel icm)` Tests whether the color indices represent a gray-scale image with the indicated number of bits over the color component range [0,255].
`static boolean`	`isIndicesForGrayscale(byte[] r, byte[] g, byte[] b)` Tests whether the color indices represent a gray-scale image.
`static boolean`	`isNonStandardICCColorSpace(ColorSpace cs)` Returns `true` if the given `ColorSpace` object is an instance of `ICC_ColorSpace` but is not one of the standard `ColorSpace`s returned by `ColorSpace.getInstance()`.
`static void`	`processOnRegistration(ServiceRegistry registry, Class category, String formatName, ImageReaderWriterSpi spi, int deregisterJvmVersion, int priorityJvmVersion)`
`static int`	`readMultiByteInteger(ImageInputStream iis)`
`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()`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ImageUtil
```
public ImageUtil()
```
- Method Detail
  - createColorModel
```
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.
  - getPackedBinaryData
```
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.
  - getUnpackedBinaryData
```
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.
  - setPackedBinaryData
```
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.
  - setUnpackedBinaryData
```
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.
  - isBinary
```
public static boolean isBinary(SampleModel sm)
```
  - createColorModel
```
public static ColorModel createColorModel(ColorSpace colorSpace,
                                          SampleModel sampleModel)
```
  - getElementSize
```
public static int getElementSize(SampleModel sm)
```
  - getTileSize
```
public static long getTileSize(SampleModel sm)
```
  - getBandSize
```
public static long getBandSize(SampleModel sm)
```
  - isGrayscaleMapping
```
public static boolean isGrayscaleMapping(IndexColorModel icm)
```
    Tests whether the color indices represent a gray-scale image with the indicated number of bits over the color component range [0,255]. The grayscale mapping may be inverted, i.e., 0 -> 255 and mapSize -> 0.
    
    Parameters:
    
    icm - The gray-to-color mapping.
    
    Returns:
    
    Whether the IndexColorModel maps index i to ((255*i)/icm.getMapSize()-1).
    
    Throws:
    
    IllegalArgumentException - if icm is null.
  - isIndicesForGrayscale
```
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.
  - convertObjectToString
```
public static String convertObjectToString(Object obj)
```
    Converts the provided object to String
  - canEncodeImage
```
public static final void canEncodeImage(ImageWriter writer,
                                        ImageTypeSpecifier type)
                                 throws IIOException
```
    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.
  - canEncodeImage
```
public static final void canEncodeImage(ImageWriter writer,
                                        ColorModel colorModel,
                                        SampleModel sampleModel)
                                 throws IIOException
```
    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.
  - imageIsContiguous
```
public static final boolean imageIsContiguous(RenderedImage image)
```
    Returns whether the image has contiguous data across rows.
  - getDestinationType
```
public static final ImageTypeSpecifier getDestinationType(ImageReadParam param,
                                                          Iterator imageTypes)
                                                   throws IIOException
```
    Gets the destination image type.
    
    Throws:
    
    IIOException
  - isNonStandardICCColorSpace
```
public static boolean isNonStandardICCColorSpace(ColorSpace cs)
```
    Returns true if the given ColorSpace object is an instance of ICC_ColorSpace but is not one of the standard ColorSpaces returned by ColorSpace.getInstance().
    
    Parameters:
    
    cs - The ColorSpace to test.
  - getJDKImageReaderWriterSPI
```
public static List getJDKImageReaderWriterSPI(ServiceRegistry registry,
                                              String formatName,
                                              boolean isReader)
```
  - processOnRegistration
```
public static void processOnRegistration(ServiceRegistry registry,
                                         Class category,
                                         String formatName,
                                         ImageReaderWriterSpi spi,
                                         int deregisterJvmVersion,
                                         int priorityJvmVersion)
```
  - readMultiByteInteger
```
public static int readMultiByteInteger(ImageInputStream iis)
                                throws IOException
```
    Throws:
    
    IOException

Class ImageUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageUtil

Method Detail

createColorModel

getPackedBinaryData

getUnpackedBinaryData

setPackedBinaryData

setUnpackedBinaryData

isBinary

createColorModel

getElementSize

getTileSize

getBandSize

isGrayscaleMapping

isIndicesForGrayscale

convertObjectToString

canEncodeImage

canEncodeImage

imageIsContiguous

getDestinationType

isNonStandardICCColorSpace

getJDKImageReaderWriterSPI

processOnRegistration

readMultiByteInteger