com.jhlabs.image

Class SaturationFilter

Implemented Interfaces:
BufferedImageOp, Cloneable

public class SaturationFilter
extends PointFilter

A filter to change the saturation of an image. This works by calculating a grayscale version of the image and then extrapolating away from it.

Field Summary

float
amount

Fields inherited from class com.jhlabs.image.PointFilter

canFilterIndexColorModel

Constructor Summary

SaturationFilter()
Construct a SaturationFilter.
SaturationFilter(float amount)
Construct a SaturationFilter.

Method Summary

int
filterRGB(int x, int y, int rgb)
float
getAmount()
Set the amount of saturation change.
void
setAmount(float amount)
Set the amount of saturation change.
String
toString()

Methods inherited from class com.jhlabs.image.PointFilter

filter, filterRGB, setDimensions

Methods inherited from class com.jhlabs.image.AbstractBufferedImageOp

clone, createCompatibleDestImage, getBounds2D, getPoint2D, getRGB, getRenderingHints, setRGB

Field Details

amount

public float amount

Constructor Details

SaturationFilter

public SaturationFilter()
Construct a SaturationFilter.

SaturationFilter

public SaturationFilter(float amount)
Construct a SaturationFilter. The amount of saturation change.

Method Details

filterRGB

public int filterRGB(int x,
                     int y,
                     int rgb)
Overrides:
filterRGB in interface PointFilter

getAmount

public float getAmount()
Set the amount of saturation change.
Returns:
the amount

setAmount

public void setAmount(float amount)
Set the amount of saturation change. 1 leaves the image unchanged, values between 0 and 1 desaturate, 0 completely desaturates it and values above 1 increase the saturation.
Parameters:
amount - the amount

toString

public String toString()