javax.media.jai.operator
Class ConjugateDescriptor

java.lang.Object
  |
  +--javax.media.jai.OperationDescriptorImpl
        |
        +--javax.media.jai.operator.ConjugateDescriptor

All Implemented Interfaces:

OperationDescriptor, RegistryElementDescriptor, Serializable

public class ConjugateDescriptor

extends OperationDescriptorImpl

An OperationDescriptor describing the "Conjugate" operation.

The Conjugate operation negates the imaginary components of pixel values of a rendered or renderable source image containing complex data. The source image must contain an even number of bands with the even-indexed bands (0, 2, ...) representing the real and the odd-indexed bands (1, 3, ...) the imaginary parts of each pixel. The destination image similarly contains an even number of bands with the same interpretation and with contents defined by:

 dst[x][y][2*k]   =  src[x][y][2*k];
 dst[x][y][2*k+1] = -src[x][y][2*k+1];
 

where the index k varies from zero to one less than the number of complex components in the destination image.

"Conjugate" defines a PropertyGenerator that sets the "COMPLEX" property of the image to java.lang.Boolean.TRUE, which may be retrieved by calling the getProperty() method with "COMPLEX" as the property name.

Resource List

Name	Value
GlobalName	Conjugate
LocalName	Conjugate
Vendor	com.sun.media.jai
Description	Computes the complex conjugate of a complex image.
DocURL	http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/ConjugateDescriptor.html
Version	1.0

No parameters are needed for the "Conjugate" operation.

See Also:

OperationDescriptor, Serialized Form

Fields inherited from class javax.media.jai.OperationDescriptorImpl

resources, sourceNames, supportedModes

Fields inherited from interface javax.media.jai.OperationDescriptor

NO_PARAMETER_DEFAULT

Constructor Summary

ConjugateDescriptor()
Constructor.

Method Summary

static RenderedOp	create(RenderedImage source0, RenderingHints hints) Computes the complex conjugate of a complex image.
static RenderableOp	createRenderable(RenderableImage source0, RenderingHints hints) Computes the complex conjugate of a complex image.
PropertyGenerator[]	getPropertyGenerators(String modeName) Returns an array of PropertyGenerators implementing property inheritance for the "Conjugate" operation.
protected boolean	validateSources(String modeName, ParameterBlock args, StringBuffer msg) Validates the input sources.

Methods inherited from class javax.media.jai.OperationDescriptorImpl

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ConjugateDescriptor

public ConjugateDescriptor()

Constructor.

Method Detail

getPropertyGenerators

public PropertyGenerator[] getPropertyGenerators(String modeName)

Returns an array of PropertyGenerators implementing property inheritance for the "Conjugate" operation.

Overrides:

getPropertyGenerators in class OperationDescriptorImpl

Returns:

An array of property generators.

validateSources

protected boolean validateSources(String modeName,
                                  ParameterBlock args,
                                  StringBuffer msg)

Validates the input sources.

In addition to the standard checks performed by the superclass method, this method checks that the source image has an even number of bands.

Overrides:

validateSources in class OperationDescriptorImpl

Following copied from class: javax.media.jai.OperationDescriptorImpl

Parameters:

modeName - the operation mode name

args - a ParameterBlock that has the sources

msg - A string that may contain error messages.

Throws:

IllegalArgumentException - if any of the input parameters are null.

See Also:

OperationDescriptorImpl.validateArguments(java.lang.String, java.awt.image.renderable.ParameterBlock, java.lang.StringBuffer)

create

public static RenderedOp create(RenderedImage source0,
                                RenderingHints hints)

Computes the complex conjugate of a complex image.

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

Parameters:

source0 - RenderedImage source 0.

hints - The RenderingHints to use. May be null.

Returns:

The RenderedOp destination.

Throws:

IllegalArgumentException - if source0 is null.

See Also:

JAI, ParameterBlockJAI, RenderedOp

createRenderable

public static RenderableOp createRenderable(RenderableImage source0,
                                            RenderingHints hints)

Computes the complex conjugate of a complex image.

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

Parameters:

source0 - RenderableImage source 0.

hints - The RenderingHints to use. May be null.

Returns:

The RenderableOp destination.

Throws:

IllegalArgumentException - if source0 is null.

See Also:

JAI, ParameterBlockJAI, RenderableOp