BinaryFilter

java.lang.Object
- com.jhlabs.image.AbstractBufferedImageOp
- - com.jhlabs.image.WholeImageFilter
  - - com.jhlabs.image.BinaryFilter

All Implemented Interfaces:

java.awt.image.BufferedImageOp, java.lang.Cloneable

Direct Known Subclasses:

DilateFilter, ErodeFilter, LifeFilter, OutlineFilter, SkeletonFilter
```
public abstract class BinaryFilter
extends WholeImageFilter
```
The superclass for some of the filters which work on binary images.

Field Summary

Fields
Modifier and Type Field Description

protected BinaryFunction blackFunction

protected Colormap colormap

protected int iterations

protected int newColor
- Fields inherited from class com.jhlabs.image.WholeImageFilter
  originalSpace, transformedSpace

Constructor Summary

Constructors
Constructor Description

BinaryFilter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BinaryFunction`	`getBlackFunction()`
`Colormap`	`getColormap()`	Get the colormap to be used for the filter.
`int`	`getIterations()`	Get the number of iterations the effect is performed.
`int`	`getNewColor()`
`void`	`setBlackFunction(BinaryFunction blackFunction)`
`void`	`setColormap(Colormap colormap)`	Set the colormap to be used for the filter.
`void`	`setIterations(int iterations)`	Set the number of iterations the effect is performed.
`void`	`setNewColor(int newColor)`

Methods inherited from class com.jhlabs.image.WholeImageFilter
filter, filterPixels, transformSpace

Methods inherited from class com.jhlabs.image.AbstractBufferedImageOp
clone, createCompatibleDestImage, getBounds2D, getPoint2D, getRenderingHints, getRGB, setRGB, stringToColor

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

- Field Detail
  - newColor
```
protected int newColor
```
  - blackFunction
```
protected BinaryFunction blackFunction
```
  - iterations
```
protected int iterations
```
  - colormap
```
protected Colormap colormap
```
- Constructor Detail
  - BinaryFilter
```
public BinaryFilter()
```
- Method Detail
  - setIterations
```
public void setIterations(int iterations)
```
    Set the number of iterations the effect is performed.
    
    Parameters:
    
    iterations - the number of iterations, min-value 0
    
    See Also:
    
    getIterations()
  - getIterations
```
public int getIterations()
```
    Get the number of iterations the effect is performed.
    
    Returns:
    
    the number of iterations
    
    See Also:
    
    setIterations(int)
  - setColormap
```
public void setColormap(Colormap colormap)
```
    Set the colormap to be used for the filter.
    
    Parameters:
    
    colormap - the colormap
    
    See Also:
    
    getColormap()
  - getColormap
```
public Colormap getColormap()
```
    Get the colormap to be used for the filter.
    
    Returns:
    
    the colormap
    
    See Also:
    
    setColormap(com.jhlabs.image.Colormap)
  - setNewColor
```
public void setNewColor(int newColor)
```
  - getNewColor
```
public int getNewColor()
```
  - setBlackFunction
```
public void setBlackFunction(BinaryFunction blackFunction)
```
  - getBlackFunction
```
public BinaryFunction getBlackFunction()
```