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

The Or operation takes one rendered or renderable image and an array of integer constants, and performs a bit-wise logical "or" between every pixel in the same band of the source and the constant from the corresponding array entry. If the number of constants supplied is less than the number of bands of the destination, then the constant from entry 0 is applied to all the bands. Otherwise, a constant from a different entry is applied to each band.

The source image must have an integral data type. By default, the destination image bound, data type, and number of bands are the same as the source image.

The following matrix defines the logical "or" operation.

Logical "or"

src	const	Result
0	0	0
0	1	1
1	0	1
1	1	1

The destination pixel values are defined by the pseudocode:

 if (constants.length < dstNumBands) {
 dst[x][y][b] = src[x][y][b] | constants[0];
 } else {
 dst[x][y][b] = src[x][y][b] | constants[b];
 }
 

Resource List

Name	Value
GlobalName	OrConst
LocalName	OrConst
Vendor	com.sun.media.jai
Description	Logically "ors" an image with constants.
DocURL	http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/OrConstDescriptor.html
Version	1.0
arg0Desc	The constants to logically "or" with.

Parameter List

Name	Class Type	Default Value
constants	int[]	{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:
  constants - The constants to logically "or" with.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:
  constants - The constants to logically "or" with.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:
  constants - The constants to logically "or" with.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:
  constants - The constants to logically "or" with.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 the source image has an integral data type and that "constants" has length at least 1.