com.jhlabs.image

Class DitherFilter

java.lang.Object

com.jhlabs.image.AbstractBufferedImageOp

com.jhlabs.image.PointFilter

com.jhlabs.image.DitherFilter

All Implemented Interfaces:

BufferedImageOp, Cloneable, FilterListener, ImageFilterOpSupport

public class DitherFilter
extends PointFilter

A filter which performs ordered dithering on an image.

Author:

Jerry Huxtable (2006), Adam Zimowski (mrazjava) (2013) - event handling and warning cleanup

Field Summary

Fields

Modifier and Type	Field and Description
static int[]	dither90Halftone6x6Matrix 6x6 90 degree halftone.
static int[]	ditherCluster3Matrix Order-3 clustered dither.
static int[]	ditherCluster4Matrix Order-4 clustered dither.
static int[]	ditherCluster8Matrix Order-8 clustered dither.
static int[]	ditherLines4x4Matrix 4x4 lines.
protected static int[]	ditherMagic2x2Matrix 2x2 magic square.
protected static int[]	ditherMagic4x4Matrix 4x4 magic square.
static int[]	ditherOrdered4x4Matrix 4x4 ordered dither.
static int[]	ditherOrdered6x6Matrix Order-6 ordered dither.
static int[]	ditherOrdered8x8Matrix Order-8 ordered dither.

Fields inherited from class com.jhlabs.image.PointFilter

canFilterIndexColorModel

Fields inherited from class com.jhlabs.image.AbstractBufferedImageOp

filterListener

Constructor Summary

Constructors

Constructor and Description
DitherFilter() Constuct a DitherFilter.

Method Summary

Methods

Modifier and Type	Method and Description
int	filterRGB(int x, int y, int rgb)
boolean	getColorDither() Get whether to use a color dither.
int	getLevels() Get the number of dither levels.
int[]	getMatrix() Get the dither matrix.
ImageFilterOps	getMetaData() Bambi filter metadata.
protected void	initialize() Initialize the filter.
void	setColorDither(boolean colorDither) Set whether to use a color dither.
void	setLevels(int levels) Set the number of dither levels.
void	setMatrix(int[] matrix) Set the dither matrix.
String	toString()

Methods inherited from class com.jhlabs.image.PointFilter

filter, setDimensions

Methods inherited from class com.jhlabs.image.AbstractBufferedImageOp

clone, createCompatibleDestImage, createCompatibleDestImage, filterDone, filterInitialize, filterProgress, filterStart, getBounds2D, getPoint2D, getRenderingHints, getRGB, setFilterListener, setRGB

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ditherMagic2x2Matrix

protected static final int[] ditherMagic2x2Matrix

2x2 magic square.

ditherMagic4x4Matrix

protected static final int[] ditherMagic4x4Matrix

4x4 magic square.

ditherOrdered4x4Matrix

public static final int[] ditherOrdered4x4Matrix

4x4 ordered dither.

ditherLines4x4Matrix

public static final int[] ditherLines4x4Matrix

4x4 lines.

dither90Halftone6x6Matrix

public static final int[] dither90Halftone6x6Matrix

6x6 90 degree halftone.

ditherOrdered6x6Matrix

public static final int[] ditherOrdered6x6Matrix

Order-6 ordered dither.

ditherOrdered8x8Matrix

public static final int[] ditherOrdered8x8Matrix

Order-8 ordered dither.

ditherCluster3Matrix

public static final int[] ditherCluster3Matrix

Order-3 clustered dither.

ditherCluster4Matrix

public static final int[] ditherCluster4Matrix

Order-4 clustered dither.

ditherCluster8Matrix

public static final int[] ditherCluster8Matrix

Order-8 clustered dither.

Constructor Detail

DitherFilter

public DitherFilter()

Constuct a DitherFilter.

Method Detail

setMatrix

public void setMatrix(int[] matrix)

Set the dither matrix.

Parameters:

matrix - the dither matrix

See Also:

getMatrix()

getMatrix

public int[] getMatrix()

Get the dither matrix.

Returns:

the dither matrix

See Also:

setMatrix(int[])

setLevels

public void setLevels(int levels)

Set the number of dither levels.

Parameters:

levels - the number of levels

See Also:

getLevels()

getLevels

public int getLevels()

Get the number of dither levels.

Returns:

the number of levels

See Also:

setLevels(int)

setColorDither

public void setColorDither(boolean colorDither)

Set whether to use a color dither.

Parameters:

colorDither - whether to use a color dither

See Also:

getColorDither()

getColorDither

public boolean getColorDither()

Get whether to use a color dither.

Returns:

whether to use a color dither

See Also:

getColorDither()

initialize

protected void initialize()

Initialize the filter.

filterRGB

public int filterRGB(int x,
            int y,
            int rgb)

Specified by:

filterRGB in class PointFilter

toString

public String toString()

Overrides:

toString in class Object

getMetaData

public ImageFilterOps getMetaData()

Description copied from class: AbstractBufferedImageOp

Bambi filter metadata. This implementation always returns throws exception because this method can only be called if defined. This method should be overwritten if child filter is used within a Bambi app. The reason exception is throw rather than returning null is to help identify offending class which is much easier than tracing NPE.

Specified by:

getMetaData in interface ImageFilterOpSupport

Overrides:

getMetaData in class AbstractBufferedImageOp