javax.media.jai.operator
Class MagnitudeDescriptor

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

All Implemented Interfaces:

OperationDescriptor, RegistryElementDescriptor, Serializable

public class MagnitudeDescriptor

extends OperationDescriptorImpl

An OperationDescriptor describing the "Magnitude" operation.

The "Magnitude" operation computes the magnitude of each pixel of a complex image. The source image must have an even number of bands, with the even bands (0, 2, ...) representing the real parts and the odd bands (1, 3, ...) the imaginary parts of each complex pixel. The destination image has at most half the number of bands of the source image with each sample in a pixel representing the magnitude of the corresponding complex source sample. The magnitude values of the destination image are defined for a given sample by the pseudocode:

dstPixel[x][y][b] = sqrt(src[x][y][2*b]^2 + src[x][y][2*b + 1]^2)

where the number of bands b varies from zero to one less than the number of bands in the destination image.

For integral image datatypes, the result will be rounded and clamped as needed.

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

Resource List

Name	Value
GlobalName	Magnitude
LocalName	Magnitude
Vendor	com.sun.media.jai
Description	Find the magnitude of each pixel of an image.
DocURL	http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/MagnitudeDescriptor.html
Version	1.0

No parameters are needed for the "Magnitude" operation.

See Also:

OperationDescriptor, Serialized Form

Fields inherited from class javax.media.jai.OperationDescriptorImpl

resources, sourceNames, supportedModes

Constructor Summary

MagnitudeDescriptor()
Constructor.

Method Summary

PropertyGenerator[]	getPropertyGenerators(String modeName) Returns an array of PropertyGenerators implementing property inheritance for the "Magnitude" operation.
protected boolean	validateSources(String modeName, ParameterBlock args, StringBuffer msg) Validates the input source.

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

MagnitudeDescriptor

public MagnitudeDescriptor()

Constructor.

Method Detail

validateSources

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

Validates the input source.

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

Tags copied from class: 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)

getPropertyGenerators

public PropertyGenerator[] getPropertyGenerators(String modeName)

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

Overrides:

getPropertyGenerators in class OperationDescriptorImpl

Returns:

An array of property generators.