Java Doc for ClampDescriptor.java in  » 6.0-JDK-Modules » Java-Advanced-Imaging » javax » media » jai » operator » Java Source Code / Java DocumentationJava Source Code and Java Documentation

The Clamp operation takes one rendered or renderable source image, and sets all the pixels whose value is below a "low" value to that low value and all the pixels whose value is above a "high" value to that high value. The pixels whose value is between the "low" value and the "high" value are left unchanged.

A different set of "low" and "high" values may be applied to each band of the source image, or the same set of "low" and "high" values may be applied to all bands of the source. If the number of "low" and "high" values supplied is less than the number of bands of the source, then the values from entry 0 are applied to all the bands. Each "low" value must be less than or equal to its corresponding "high" value.

The destination pixel values are defined by the pseudocode:

 lowVal = (low.length < dstNumBands) ?
 low[0] : low[b];
 highVal = (high.length < dstNumBands) ?
 high[0] : high[b];
 if (src[x][y][b] < lowVal) {
 dst[x][y][b] = lowVal;
 } else if (src[x][y][b] > highVal) {
 dst[x][y][b] = highVal;
 } else {
 dst[x][y][b] = src[x][y][b];
 }
 

Resource List

Name	Value
GlobalName	Clamp
LocalName	Clamp
Vendor	com.sun.media.jai
Description	Clamps the pixel values of an image to a specified range.
DocURL	http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/ClampDescriptor.html
Version	1.0
arg0Desc	The lower boundary for each band.
arg1Desc	The upper boundary for each band.

Parameter List

Name	Class Type	Default Value
low	double[]	{0.0}
high	double[]	{255.0}

Creates a ParameterBlockJAI from all supplied arguments except hints and invokes JAI.create(StringParameterBlockRenderingHints) .
See Also:   JAI
See Also:   ParameterBlockJAI
See Also:   RenderedOp
Parameters:
  source0 - RenderedImage source 0.
Parameters:
  low - The lower boundary for each band.May be null.
Parameters:
  high - The upper boundary for each band.May be null.
Parameters:
  hints - The RenderingHints to use.May be null.

Creates a ParameterBlockJAI from all supplied arguments except hints and invokes JAI.createRenderable(StringParameterBlockRenderingHints) .
See Also:   JAI
See Also:   ParameterBlockJAI
See Also:   RenderableOp
Parameters:
  source0 - RenderableImage source 0.
Parameters:
  low - The lower boundary for each band.May be null.
Parameters:
  high - The upper boundary for each band.May be null.
Parameters:
  hints - The RenderingHints to use.May be null.

Creates a ParameterBlockJAI from all supplied arguments except hints and invokes JAI.create(StringParameterBlockRenderingHints) .
See Also:   JAI
See Also:   ParameterBlockJAI
See Also:   RenderedOp
Parameters:
  source0 - RenderedImage source 0.
Parameters:
  low - The lower boundary for each band.May be null.
Parameters:
  high - The upper boundary for each band.May be null.
Parameters:
  hints - The RenderingHints to use.May be null. The RenderedOp destination.
throws:
  IllegalArgumentException - if source0 is null.

Creates a ParameterBlockJAI from all supplied arguments except hints and invokes JAI.createRenderable(StringParameterBlockRenderingHints) .
See Also:   JAI
See Also:   ParameterBlockJAI
See Also:   RenderableOp
Parameters:
  source0 - RenderableImage source 0.
Parameters:
  low - The lower boundary for each band.May be null.
Parameters:
  high - The upper boundary for each band.May be null.
Parameters:
  hints - The RenderingHints to use.May be null. The RenderableOp destination.
throws:
  IllegalArgumentException - if source0 is null.

In addition to the standard checks performed by the superclass method, this method checks that "low" and "high" have length at least 1 and that each "low" value is less than or equal to the corresponding "high" value.