ImageAnalyzer (IQM 3.5 API)

java.lang.Object
- at.mug.iqm.commons.util.image.ImageAnalyzer

```
public final class ImageAnalyzer
extends Object
```
This class analyzes an image. Its methods return e.g. the color model or the size of the image.

Author:

Philipp Kainz

Field Summary

Fields
Modifier and Type Field and Description

private static org.apache.log4j.Logger logger
Custom class logger.

Fields
Modifier and Type	Field and Description
`private static org.apache.log4j.Logger`	`logger` Custom class logger.

Constructor Summary

Constructors
Constructor and Description

ImageAnalyzer()

Constructors
Constructor and Description
`ImageAnalyzer()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static byte[][]`	`getByteLookUpTable(javax.media.jai.PlanarImage img)` Returns the `LookupTable` as `byte[][]` of a given `PlanarImage`.
`static ColorModel`	`getColorModel(javax.media.jai.PlanarImage img)` Returns the `ColorModel` of a given `PlanarImage`.
`static ColorSpace`	`getColorSpace(javax.media.jai.PlanarImage img)` Returns the `ColorSpace` associated with a `ColorModel` of a given `PlanarImage`.
`static int`	`getDataBufferType(javax.media.jai.PlanarImage img)` Returns the `DataBuffer` type of a given `PlanarImage`'s `SampleModel`.
`static IndexColorModel`	`getIndexColorModel(javax.media.jai.PlanarImage img)` Returns the `IndexColorModel` of a given `PlanarImage`.
`static int`	`getNumberOfBands(javax.media.jai.PlanarImage img)` Returns the number of bands of a given `PlanarImage`.
`static int`	`getPixelBits(javax.media.jai.PlanarImage img)` Returns the pixel bits (e.g.
`static Map<String,Object>`	`getProperties(BufferedImage bi)` Read the most common properties of an image.
`static Map<String,Object>`	`getProperties(javax.media.jai.PlanarImage img)` Read the most common properties of an image.
`static SampleModel`	`getSampleModel(javax.media.jai.PlanarImage img)` Returns the `SampleModel` of a given `PlanarImage`.
`static short[][]`	`getShortLookUpTable(javax.media.jai.PlanarImage img)` Returns the `LookupTable` as normalized 8bit (0-255) `short[][]` of a given `PlanarImage`.
`static int`	`getTransparency(javax.media.jai.PlanarImage img)` Returns the `Transparency` type of a given `PlanarImage`'s `ColorModel`
`static boolean`	`has1Band(javax.media.jai.PlanarImage img)` Returns whether or not a given `PlanarImage` has `1` band.
`static boolean`	`has3Bands(javax.media.jai.PlanarImage img)` Returns whether or not a given `PlanarImage` has `3` bands.
`static boolean`	`has4Bands(javax.media.jai.PlanarImage img)` Returns whether or not a given `PlanarImage` has `4` bands (+ alpha).
`static boolean`	`hasAlphaBand(javax.media.jai.PlanarImage img)` Returns whether or not a given `PlanarImage`'s `ColorModel` uses the alpha band.
`static boolean`	`is12Bit3Band(javax.media.jai.PlanarImage img)` Returns whether or not a given `PlanarImage` is an 12bit three band image without an alpha band.
`static boolean`	`is12Bit4Band(javax.media.jai.PlanarImage img)` Returns whether or not a given `PlanarImage` is an 12bit four band image with an alpha band.
`static boolean`	`is12BitGrey(javax.media.jai.PlanarImage img)` Returns whether or not a given `PlanarImage` is an 12bit grey value single band image without an alpha band.
`static boolean`	`is16Bit3Band(javax.media.jai.PlanarImage img)` Returns whether or not a given `PlanarImage` is an 16bit three band image without an alpha band.
`static boolean`	`is16Bit4Band(javax.media.jai.PlanarImage img)` Returns whether or not a given `PlanarImage` is an 16bit four band image with an alpha band.
`static boolean`	`is16BitGrey(javax.media.jai.PlanarImage img)` Returns whether or not a given `PlanarImage` is an 16bit grey value single band image without an alpha band.
`static boolean`	`is8Bit3Band(javax.media.jai.PlanarImage img)` Returns whether or not a given `PlanarImage` is an 8bit three band image without an alpha band.
`static boolean`	`is8Bit4Band(javax.media.jai.PlanarImage img)` Returns whether or not a given `PlanarImage` is an 8bit four band image with an alpha band.
`static boolean`	`is8BitGrey(javax.media.jai.PlanarImage img)` Returns whether or not a given `PlanarImage` is an 8bit grey value single band image without an alpha band.
`static boolean`	`isBinary(javax.media.jai.PlanarImage img)` Returns whether or not a given `PlanarImage` is an binary (1bit) value single band image without an alpha band.
`static boolean`	`isIndexed(javax.media.jai.PlanarImage img)` Returns whether or not the `ColorModel` is `IndexColorModel` of a given `PlanarImage`.
`static boolean`	`isRGB(javax.media.jai.PlanarImage img)`
`static void`	`main(String[] args)`
`static String`	`printProperties(javax.media.jai.PlanarImage pi)` Print out the most common properties of an image as HTML string.

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
```
    Custom class logger.
- Constructor Detail
  - ImageAnalyzer
```
public ImageAnalyzer()
```
- Method Detail
  - getProperties
```
public static Map<String,Object> getProperties(BufferedImage bi)
```
    Read the most common properties of an image.
    
    Parameters:
    
    bi - - the RenderedImage to analyze
    
    Returns:
    
    a Map with String key-value pairs containing the image's information.
  - getProperties
```
public static Map<String,Object> getProperties(javax.media.jai.PlanarImage img)
```
    Read the most common properties of an image.
    
    Parameters:
    
    img - - the PlanarImage to analyze
    
    Returns:
    
    a Map with key-value pairs containing the image's information.
  - printProperties
```
public static String printProperties(javax.media.jai.PlanarImage pi)
```
    Print out the most common properties of an image as HTML string.
    Each property is represented by a single row in an HTML table.
    
    Parameters:
    
    pi - - the PlanarImage to analyze
  - getSampleModel
```
public static SampleModel getSampleModel(javax.media.jai.PlanarImage img)
```
    Returns the SampleModel of a given PlanarImage.
    
    Parameters:
    
    img -
    
    Returns:
    
    the sample model
  - getDataBufferType
```
public static int getDataBufferType(javax.media.jai.PlanarImage img)
```
    Returns the DataBuffer type of a given PlanarImage's SampleModel.
    
    Parameters:
    
    img -
    
    Returns:
    
    the data buffer type
  - getNumberOfBands
```
public static int getNumberOfBands(javax.media.jai.PlanarImage img)
```
    Returns the number of bands of a given PlanarImage.
    
    Parameters:
    
    img -
    
    Returns:
    
    the number of bands
  - getColorModel
```
public static ColorModel getColorModel(javax.media.jai.PlanarImage img)
```
    Returns the ColorModel of a given PlanarImage.
    
    Parameters:
    
    img -
    
    Returns:
    
    the color model
  - isIndexed
```
public static boolean isIndexed(javax.media.jai.PlanarImage img)
```
    Returns whether or not the ColorModel is IndexColorModel of a given PlanarImage.
    
    Parameters:
    
    img -
    
    Returns:
    
    true if indexed, false otherwise
  - getIndexColorModel
```
public static IndexColorModel getIndexColorModel(javax.media.jai.PlanarImage img)
```
    Returns the IndexColorModel of a given PlanarImage.
    
    Parameters:
    
    img -
    
    Returns:
    
    null, if the ColorModel is not IndexColorModel
  - getByteLookUpTable
```
public static byte[][] getByteLookUpTable(javax.media.jai.PlanarImage img)
```
    Returns the LookupTable as byte[][] of a given PlanarImage.
    
    Parameters:
    
    img -
    
    Returns:
    
    null, if the given image's ColorModel is not of IndexColorModel.
  - getShortLookUpTable
```
public static short[][] getShortLookUpTable(javax.media.jai.PlanarImage img)
```
    Returns the LookupTable as normalized 8bit (0-255) short[][] of a given PlanarImage.
    
    Parameters:
    
    img -
    
    Returns:
    
    null, if the given image's ColorModel is not of IndexColorModel.
  - getColorSpace
```
public static ColorSpace getColorSpace(javax.media.jai.PlanarImage img)
```
    Returns the ColorSpace associated with a ColorModel of a given PlanarImage.
    
    Parameters:
    
    img -
    
    Returns:
    
    the color space
  - isRGB
```
public static boolean isRGB(javax.media.jai.PlanarImage img)
```
  - getPixelBits
```
public static int getPixelBits(javax.media.jai.PlanarImage img)
```
    Returns the pixel bits (e.g. 8, 12, 16, 24, ...) of PlanarImage's ColorModel.
    
    Parameters:
    
    img -
    
    Returns:
    
    the bit per pixel
  - has1Band
```
public static boolean has1Band(javax.media.jai.PlanarImage img)
```
    Returns whether or not a given PlanarImage has 1 band.
    
    Parameters:
    
    img -
    
    Returns:
    
    true if the image has 1 band, false if not
  - has3Bands
```
public static boolean has3Bands(javax.media.jai.PlanarImage img)
```
    Returns whether or not a given PlanarImage has 3 bands.
    
    Parameters:
    
    img -
    
    Returns:
    
    true if the image has 3 bands, false if not
  - has4Bands
```
public static boolean has4Bands(javax.media.jai.PlanarImage img)
```
    Returns whether or not a given PlanarImage has 4 bands (+ alpha).
    
    Parameters:
    
    img -
    
    Returns:
    
    true if the image has 4 bands, false if not
  - hasAlphaBand
```
public static boolean hasAlphaBand(javax.media.jai.PlanarImage img)
```
    Returns whether or not a given PlanarImage's ColorModel uses the alpha band.
    
    Parameters:
    
    img -
    
    Returns:
    
    true if the image uses the alpha channel, false if not
  - isBinary
```
public static boolean isBinary(javax.media.jai.PlanarImage img)
```
    Returns whether or not a given PlanarImage is an binary (1bit) value single band image without an alpha band.
    
    Parameters:
    
    img -
    
    Returns:
    
    true if the image has a single 1bit value band, false if not
  - getTransparency
```
public static int getTransparency(javax.media.jai.PlanarImage img)
```
    Returns the Transparency type of a given PlanarImage's ColorModel
    
    Parameters:
    
    img -
    
    Returns:
    
    null if the image's color model has no transparency
  - is8BitGrey
```
public static boolean is8BitGrey(javax.media.jai.PlanarImage img)
```
    Returns whether or not a given PlanarImage is an 8bit grey value single band image without an alpha band.
    
    Parameters:
    
    img -
    
    Returns:
    
    true if the image has a single 8bit grey value band, false if not
  - is12BitGrey
```
public static boolean is12BitGrey(javax.media.jai.PlanarImage img)
```
    Returns whether or not a given PlanarImage is an 12bit grey value single band image without an alpha band.
    
    Parameters:
    
    img -
    
    Returns:
    
    true if the image has a single 12bit grey value band, false if not
  - is16BitGrey
```
public static boolean is16BitGrey(javax.media.jai.PlanarImage img)
```
    Returns whether or not a given PlanarImage is an 16bit grey value single band image without an alpha band.
    
    Parameters:
    
    img -
    
    Returns:
    
    true if the image has a single 16bit grey value band, false if not
  - is8Bit3Band
```
public static boolean is8Bit3Band(javax.media.jai.PlanarImage img)
```
    Returns whether or not a given PlanarImage is an 8bit three band image without an alpha band.
    
    Parameters:
    
    img -
    
    Returns:
    
    true if the image has 3 bands using 8bit values each, false if not
  - is12Bit3Band
```
public static boolean is12Bit3Band(javax.media.jai.PlanarImage img)
```
    Returns whether or not a given PlanarImage is an 12bit three band image without an alpha band.
    
    Parameters:
    
    img -
    
    Returns:
    
    true if the image has 3 bands using 12bit values each, false if not
  - is16Bit3Band
```
public static boolean is16Bit3Band(javax.media.jai.PlanarImage img)
```
    Returns whether or not a given PlanarImage is an 16bit three band image without an alpha band.
    
    Parameters:
    
    img -
    
    Returns:
    
    true if the image has 3 bands using 16bit values each, false if not
  - is8Bit4Band
```
public static boolean is8Bit4Band(javax.media.jai.PlanarImage img)
```
    Returns whether or not a given PlanarImage is an 8bit four band image with an alpha band.
    
    Parameters:
    
    img -
    
    Returns:
    
    true if the image has 4 bands using 8bit values each, false if not
  - is12Bit4Band
```
public static boolean is12Bit4Band(javax.media.jai.PlanarImage img)
```
    Returns whether or not a given PlanarImage is an 12bit four band image with an alpha band.
    
    Parameters:
    
    img -
    
    Returns:
    
    true if the image has 4 bands using 12bit values each, false if not
  - is16Bit4Band
```
public static boolean is16Bit4Band(javax.media.jai.PlanarImage img)
```
    Returns whether or not a given PlanarImage is an 16bit four band image with an alpha band.
    
    Parameters:
    
    img -
    
    Returns:
    
    true if the image has 4 bands using 16bit values each, false if not
  - main
```
public static void main(String[] args)
```

Class ImageAnalyzer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

Constructor Detail

ImageAnalyzer

Method Detail

getProperties

getProperties

printProperties

getSampleModel

getDataBufferType

getNumberOfBands

getColorModel

isIndexed

getIndexColorModel

getByteLookUpTable

getShortLookUpTable

getColorSpace

isRGB

getPixelBits

has1Band

has3Bands

has4Bands

hasAlphaBand

isBinary

getTransparency

is8BitGrey

is12BitGrey

is16BitGrey

is8Bit3Band

is12Bit3Band

is16Bit3Band

is8Bit4Band

is12Bit4Band

is16Bit4Band

main