javax.media.jai.operator
Class MagnitudeSquaredDescriptor
java.lang.Object
|
+--javax.media.jai.OperationDescriptorImpl
|
+--javax.media.jai.operator.MagnitudeSquaredDescriptor
- All Implemented Interfaces:
- OperationDescriptor, RegistryElementDescriptor, Serializable
- public class MagnitudeSquaredDescriptor
- extends OperationDescriptorImpl
An OperationDescriptor describing the
"MagnitudeSquared" operation.
The "MagnitudeSquared" operation computes the squared magnitude or
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 squared values of the
destination image are defined for a given sample by the pseudocode:
dstPixel[x][y][b] = 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.
"MagnitudeSquared" 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 | MagnitudeSquared |
| LocalName | MagnitudeSquared |
| Vendor | com.sun.media.jai |
| Description | Computes the squared magnitude of each
pixel of a complex image. |
| DocURL | http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/MagnitudeSquaredDescriptor.html |
| Version | 1.0 |
No parameters are needed for the "MagnitudeSquared" operation.
- See Also:
OperationDescriptor, Serialized Form
| 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 |
MagnitudeSquaredDescriptor
public MagnitudeSquaredDescriptor()
- Constructor.
getPropertyGenerators
public PropertyGenerator[] getPropertyGenerators(String modeName)
- Returns an array of
PropertyGenerators implementing
property inheritance for the "MagnitudeSquared" 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 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 nameargs - a ParameterBlock that has the sourcesmsg - 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)