javax.media.jai.operator
Class BandMergeDescriptor

java.lang.Object
  javax.media.jai.OperationDescriptorImpl
      javax.media.jai.operator.BandMergeDescriptor

All Implemented Interfaces:

OperationDescriptor, RegistryElementDescriptor, Serializable

public class BandMergeDescriptor

extends OperationDescriptorImpl

An OperationDescriptor describing the "BandMerge" operation.

The BandMerge operation takes two or more rendered or renderable images, and performs "BandMerge" on every pixel. Each source image should be non-null. The number of bands of the destination image is the sum of those of all source images.

Intuitively, "BandMerge" stacks all the bands of source images in the order given in a ParameterBlock. If image1 has three bands and image2 has one band, the bandmerged image has 4 bands. Three grayscale images can be used to merge into an RGB image in this way. The destination image bound is the intersection of the source image bounds. If the sources don't intersect, the destination will have a width and height of 0.

Resource List

Name	Value
GlobalName	BandMerge
LocalName	BandMerge
Vendor	com.sun.media.jai
Description	"bandmerges" rendered images.
DocURL	http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/BandMergeDescriptor.html
Version	1.0

No parameters are needed for this operation.

Since:

JAI 1.1

See Also:

OperationDescriptor, Serialized Form

Field Summary

Fields inherited from class javax.media.jai.OperationDescriptorImpl

sourceNames, supportedModes

Fields inherited from interface javax.media.jai.OperationDescriptor

NO_PARAMETER_DEFAULT

Constructor Summary

BandMergeDescriptor()
Constructor.

Method Summary

static RenderedOp	create(RenderedImage source0, RenderedImage source1, RenderingHints hints) Merge (possibly multi-banded)images into a multibanded image.
static RenderableOp	createRenderable(RenderableImage source0, RenderableImage source1, RenderingHints hints) Merge (possibly multi-banded)images into a multibanded image.
boolean	isRenderableSupported() Returns true since renderable operation is supported.

Methods inherited from class javax.media.jai.OperationDescriptorImpl

arePropertiesSupported, getDefaultSourceClass, getDestClass, getDestClass, getInvalidRegion, getName, getNumParameters, getNumSources, getParamClasses, getParamDefaults, getParamDefaultValue, getParameterListDescriptor, getParamMaxValue, getParamMinValue, getParamNames, getPropertyGenerators, getPropertyGenerators, getRenderableDestClass, getRenderableSourceClasses, getResourceBundle, getResources, getSourceClasses, getSourceClasses, getSourceNames, getSupportedModes, isImmediate, isModeSupported, isRenderedSupported, makeDefaultSourceClassList, validateArguments, validateArguments, validateParameters, validateParameters, validateRenderableArguments, validateRenderableSources, validateSources, validateSources

Methods inherited from class java.lang.Object

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

Constructor Detail

BandMergeDescriptor

public BandMergeDescriptor()

Constructor.

Method Detail

isRenderableSupported

public boolean isRenderableSupported()

Returns true since renderable operation is supported.

Specified by:

isRenderableSupported in interface OperationDescriptor

Overrides:

isRenderableSupported in class OperationDescriptorImpl

See Also:

OperationDescriptorImpl.isModeSupported(java.lang.String)

create

public static RenderedOp create(RenderedImage source0,
                                RenderedImage source1,
                                RenderingHints hints)

Merge (possibly multi-banded)images into a multibanded image.

Creates a ParameterBlockJAI from all supplied arguments except hints and invokes JAI.create(String,ParameterBlock,RenderingHints).

Parameters:

source0 - RenderedImage source 0.

source1 - RenderedImage source 1.

hints - The RenderingHints to use. May be null.

Returns:

The RenderedOp destination.

Throws:

IllegalArgumentException - if source0 is null.

IllegalArgumentException - if source1 is null.

See Also:

JAI, ParameterBlockJAI, RenderedOp

createRenderable

public static RenderableOp createRenderable(RenderableImage source0,
                                            RenderableImage source1,
                                            RenderingHints hints)

Merge (possibly multi-banded)images into a multibanded image.

Creates a ParameterBlockJAI from all supplied arguments except hints and invokes JAI.createRenderable(String,ParameterBlock,RenderingHints).

Parameters:

source0 - RenderableImage source 0.

source1 - RenderableImage source 1.

hints - The RenderingHints to use. May be null.

Returns:

The RenderableOp destination.

Throws:

IllegalArgumentException - if source0 is null.

IllegalArgumentException - if source1 is null.

See Also:

JAI, ParameterBlockJAI, RenderableOp