org.cell2d

Class ColorMapFilter

java.lang.Object

org.cell2d.ColorMapFilter

All Implemented Interfaces:

Filter

public class ColorMapFilter
extends java.lang.Object
implements Filter

A ColorMapFilter is a Filter that uses a Map<Color,Color> to replace some RGB values with others in the filtered image. For each key in the ColorMapFilter's Map with an alpha value of 1, all pixels in the original image that share their RGB value with that key will have their RGB value replaced with that of the key's value in the Map. The alpha values of the original image's pixels are left unchanged in the filtered image, and the alpha values of the Map's values are irrelevant to the ColorMapFilter's behavior.

See Also:

Color

Constructor Summary

Constructors

Constructor and Description
ColorMapFilter(Color key, Color value) Constructs a ColorMapFilter with a Map that maps the specified key Color to the specified value Color.
ColorMapFilter(java.util.Map<Color,Color> colorMap) Constructs a ColorMapFilter that uses a copy of the specified Map.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns whether the specified object is a ColorMapFilter that is equal to this ColorMapFilter.
java.util.Map<Color,Color>	getColorMap() Returns an unmodifiable view of the Map that this ColorMapFilter uses.
Image	getFilteredImage(Image image) Returns the transformation through this Filter of the specified Celick image.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

ColorMapFilter

public ColorMapFilter(java.util.Map<Color,Color> colorMap)

Constructs a ColorMapFilter that uses a copy of the specified Map.

Parameters:

colorMap - The Map whose copy should be used

ColorMapFilter

public ColorMapFilter(Color key,
                      Color value)

Constructs a ColorMapFilter with a Map that maps the specified key Color to the specified value Color.

Parameters:

key - The key Color

value - The value Color

Method Detail

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Returns whether the specified object is a ColorMapFilter that is equal to this ColorMapFilter. Two ColorMapFilters are equal if and only if the Maps they use are equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to be compared with this ColorMapFilter

Returns:

Whether the specified object is a ColorMapFilter that is equal to this ColorMapFilter

getColorMap

public final java.util.Map<Color,Color> getColorMap()

Returns an unmodifiable view of the Map that this ColorMapFilter uses.

Returns:

The Map that this ColorMapFilter uses

getFilteredImage

public final Image getFilteredImage(Image image)

Description copied from interface: Filter

Returns the transformation through this Filter of the specified Celick image.

Specified by:

getFilteredImage in interface Filter

Parameters:

image - The Image to be transformed

Returns:

The transformation of the specified Image