PixelMap

java.lang.Object
- triana.types.image.PixelMap

All Implemented Interfaces:

java.io.Serializable
```
public class PixelMap
extends java.lang.Object
implements java.io.Serializable
```
PixelMap is a class which represents the pixels within an image.
A pixel map may be created from an image, as a blank map, as a copy of an existing pixel map, or from input related to a particular color image encoding. Allowed encodings are defined in this class, and are used for, eg, choosing the particular colors used in a color map representation of numerical data. The class contains methods which allow setting the value of a pixel, retrieving its value and flood filling areas of pixels.
Images are stored in an integer array. Each element (pixel) of the array stores RGB information in different groups of bits: the lowest 8 bits contains blue, the next highest 8 bits holds green, and the next highest 8 bits red. The highest 8 bits of each int are ignored.
The Triana Color Map model is a one-dimensional list of 256 colors running from red (lowest) to blue (highest). They run through the visible spectrum using rgb colors that are fully saturated and of medium brightness. The color model is designated by the static integer TRIANA_COLOR_MAP and is defined by the static array of rgb values called trianaColorMapTable.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`height`
`int[]`	`pixels`
`static int`	`TRIANA_COLOR_MAP` Defining index for the Triana Color Map model.
`static int[]`	`trianaColorMapTable` Table that defines the 256 rgb values of the Triana Color Map.
`int`	`width`

Constructor Summary

Constructors
Constructor and Description
`PixelMap()`
`PixelMap(java.awt.Image image)` Creates a PixelMap object of the same dimensions as the given image and tries to include the pixel information of the image.
`PixelMap(int[][] colorMatrix, int model)` Creates a PixelMap object from an input matrix of color values according to the given color map model, as defined in this class.
`PixelMap(int width, int height)` Creates a PixelMap object of the given dimensions and clears the pixel map to all black pixels.
`PixelMap(int width, int height, boolean clear)` Creates a PixelMap object of the given dimensions with the option of clearing the pixel map to all black pixels.
`PixelMap(PixelMap pixelmap)` Creates a PixelMap object which is a copy of the PixelMap object supplied.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears the pixel map to all black pixels.
`void`	`fillBlack(int x, int y, int pixel)` Fills a black area to the given colour
`void`	`fillColour(int x, int y, int pixel, int oldpixel)` Flood fills an area of oldpixel values with pixel values starting at coordinate (x, y).
`void`	`fillErase(int x, int y)` Fills a non black area to black, ie erases the colour
`ImageHistogram`	`getBlueHistogram()` Returns a Histogram object containing the histogram of the values in the blue channel of the image.
`ImageHistogram`	`getGreenHistogram()` Returns a Histogram object containing the histogram for the values in the green channel of the image.
`int`	`getHeight()` Returns the height of the pixel map in pixels.
`java.awt.image.ImageProducer`	`getImageProducer()` Returns an ImageProducer for the data contained within the PixelMap.
`ImageHistogram`	`getIntensityHistogram()` Returns a Histogram object containing the histogram of the intensities of the pixels in the image.
`int`	`getLength()` Returns the size of the pixel map.
`int`	`getPixel(int x, int y)`
`int[]`	`getPixels()` Returns the array of pixels.
`ImageHistogram`	`getRedHistogram()` Returns a Histogram object containing the histogram for the values in the red channel of the image.
`int`	`getWidth()` Returns the width of the pixel map in pixels.
`int`	`rgbOfTrianaColorMapColor(int c)` Returns the rgb value of a given color in the Triana Color Map model.
`void`	`setPixel(int x, int y, int value)`
`int`	`trianaColorMapColorOf(int p)` Returns the Triana Color Map color value associated with a given rgb pixel value.

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

- Field Detail
  - width
```
public int width
```
  - height
```
public int height
```
  - pixels
```
public int[] pixels
```
  - TRIANA_COLOR_MAP
```
public static int TRIANA_COLOR_MAP
```
    Defining index for the Triana Color Map model.
  - trianaColorMapTable
```
public static int[] trianaColorMapTable
```
    Table that defines the 256 rgb values of the Triana Color Map.
- Constructor Detail
  - PixelMap
```
public PixelMap()
```
  - PixelMap
```
public PixelMap(int width,
        int height,
        boolean clear)
```
    Creates a PixelMap object of the given dimensions with the option of clearing the pixel map to all black pixels. If it is not cleared, the initial map will be transparent black.
    
    Parameters:
    width - The width of the map
    height - The height of the map
    clear - true if the map is to be cleared to black.
  - PixelMap
```
public PixelMap(int width,
        int height)
```
    Creates a PixelMap object of the given dimensions and clears the pixel map to all black pixels.
    
    Parameters:
    width - The width of the map
    height - The height of the map
  - PixelMap
```
public PixelMap(java.awt.Image image)
```
    Creates a PixelMap object of the same dimensions as the given image and tries to include the pixel information of the image. If unsuccessful the pixel map contains black pixels.
    
    Parameters:
    image - The given image to be made into the pixel map
  - PixelMap
```
public PixelMap(PixelMap pixelmap)
```
    Creates a PixelMap object which is a copy of the PixelMap object supplied.
    
    Parameters:
    pixelmap - The given PixelMap objet.
  - PixelMap
```
public PixelMap(int[][] colorMatrix,
        int model)
```
    Creates a PixelMap object from an input matrix of color values according to the given color map model, as defined in this class.
    
    Parameters:
    colorMatrix - A matrix containing the color values of the model
    model - An integer that designates which model is being used
- Method Detail
  - getImageProducer
```
public java.awt.image.ImageProducer getImageProducer()
```
    Returns an ImageProducer for the data contained within the PixelMap.
  - clear
```
public void clear()
```
    Clears the pixel map to all black pixels.
  - getWidth
```
public int getWidth()
```
    Returns the width of the pixel map in pixels.
  - getHeight
```
public int getHeight()
```
    Returns the height of the pixel map in pixels.
  - getPixels
```
public int[] getPixels()
```
    Returns the array of pixels.
  - getLength
```
public int getLength()
```
    Returns the size of the pixel map.
  - getPixel
```
public int getPixel(int x,
           int y)
```
  - setPixel
```
public void setPixel(int x,
            int y,
            int value)
```
  - rgbOfTrianaColorMapColor
```
public int rgbOfTrianaColorMapColor(int c)
```
    Returns the rgb value of a given color in the Triana Color Map model.
    
    Parameters:
    c - The given color value on the Triana Color Map scale
    
    Returns:
    int The rgb value that the given color value is mapped to
  - trianaColorMapColorOf
```
public int trianaColorMapColorOf(int p)
```
    Returns the Triana Color Map color value associated with a given rgb pixel value. If the rgb value is not associated with any color value then this returns -2. If the rgb value is black, the method returns -1. If the color is white, the method returns 256.
    
    Parameters:
    p - The rgb value of the given pixel
    
    Returns:
    int The Triana Color Map color value
  - fillColour
```
public void fillColour(int x,
              int y,
              int pixel,
              int oldpixel)
```
    Flood fills an area of oldpixel values with pixel values starting at coordinate (x, y).
    If uses a scanline method to reduce recursion and increase speed and efficiency.
  - fillBlack
```
public void fillBlack(int x,
             int y,
             int pixel)
```
    Fills a black area to the given colour
  - fillErase
```
public void fillErase(int x,
             int y)
```
    Fills a non black area to black, ie erases the colour
  - getRedHistogram
```
public ImageHistogram getRedHistogram()
```
    Returns a Histogram object containing the histogram for the values in the red channel of the image.
  - getGreenHistogram
```
public ImageHistogram getGreenHistogram()
```
    Returns a Histogram object containing the histogram for the values in the green channel of the image.
  - getBlueHistogram
```
public ImageHistogram getBlueHistogram()
```
    Returns a Histogram object containing the histogram of the values in the blue channel of the image.
  - getIntensityHistogram
```
public ImageHistogram getIntensityHistogram()
```
    Returns a Histogram object containing the histogram of the intensities of the pixels in the image.

Class PixelMap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

width

height

pixels

TRIANA_COLOR_MAP

trianaColorMapTable

Constructor Detail

PixelMap

PixelMap

PixelMap

PixelMap

PixelMap

PixelMap

Method Detail

getImageProducer

clear

getWidth

getHeight

getPixels

getLength

getPixel

setPixel

rgbOfTrianaColorMapColor

trianaColorMapColorOf

fillColour

fillBlack

fillErase

getRedHistogram

getGreenHistogram

getBlueHistogram

getIntensityHistogram