javax.media.jai.operator
Class PolarToComplexDescriptor

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

All Implemented Interfaces:

OperationDescriptor, RegistryElementDescriptor, Serializable

public class PolarToComplexDescriptor

extends OperationDescriptorImpl

An OperationDescriptor describing the "PolarToComplex" operation.

The "PolarToComplex" operation creates an image with complex-valued pixels from two images the respective pixel values of which represent the magnitude (modulus) and phase of the corresponding complex pixel in the destination image. The source images should have the same number of bands. The first source image contains the magnitude values and the second source image the phase values. The destination will have twice as many 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 pixel values of the destination image are defined for a given complex sample by the pseudocode:

 dst[x][y][2*b]   = src0[x][y][b]*Math.cos(src1[x][y][b])
 dst[x][y][2*b+1] = src0[x][y][b]*Math.sin(src1[x][y][b])
 

where the index b varies from zero to one less than the number of bands in the source images.

For phase images with integral data type, it is assumed that the actual phase angle is scaled from the range [-PI, PI] to the range [0, MAX_VALUE] where MAX_VALUE is the maximum value of the data type in question.

"PolarToComplex" 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	PolarToComplex
LocalName	PolarToComplex
Vendor	com.sun.media.jai
Description	Computes a complex image from a magnitude and a phase image.
DocURL	http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/PolarToComplexDescriptor.html
Version	1.0

No parameters are needed for the "PolarToComplex" operation.

See Also:

OperationDescriptor, PhaseDescriptor, Serialized Form

Field Summary

Fields inherited from class javax.media.jai.OperationDescriptorImpl

sourceNames

Fields inherited from interface javax.media.jai.OperationDescriptor

NO_PARAMETER_DEFAULT

Constructor Summary

PolarToComplexDescriptor()
Constructor.

Method Summary

static RenderedOp	create(RenderedImage source0, RenderedImage source1, RenderingHints hints) Computes a complex image from a magnitude and a phase image.
static RenderableOp	createRenderable(RenderableImage source0, RenderableImage source1, RenderingHints hints) Computes a complex image from a magnitude and a phase 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

PolarToComplexDescriptor

public PolarToComplexDescriptor()

Constructor.

Method Detail

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 images have the same number of bands.

Overrides:

validateSources in class OperationDescriptorImpl

Parameters:

modeName - the operation mode name

args - a ParameterBlock that has the sources

msg - A string that may contain error messages.

See Also:

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

getPropertyGenerators

public PropertyGenerator[] getPropertyGenerators(String modeName)

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

Specified by:

getPropertyGenerators in interface RegistryElementDescriptor

Overrides:

getPropertyGenerators in class OperationDescriptorImpl

Parameters:

modeName - the registry mode name

Returns:

An array of property generators.

See Also:

RegistryElementDescriptor

create

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

Computes a complex image from a magnitude and a phase 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)

Computes a complex image from a magnitude and a phase 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