javax.media.jai.operator
Class LogDescriptor

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

All Implemented Interfaces:

OperationDescriptor, RegistryElementDescriptor, Serializable

public class LogDescriptor

extends OperationDescriptorImpl

An OperationDescriptor describing the "Log" operation.

The "Log" operation takes the natural logarithm of the pixel values of an image. The operation is done on a per-pixel, per-band basis. For integral data types, the result will be rounded and clamped as needed. The pixel values of the destination image are defined as:

 dst[x][y][b] = java.lang.Math.log(src[x][y][b])
 

For all integral data types, the log of 0 is set to 0. For signed integral data types (short and int), the log of a negative pixel value is set to -1.

For all floating point data types ((float and double), the log of 0 is set to -Infinity, and the log of a negative pixel value is set to NaN.

Resource List

Name	Value
GlobalName	Log
LocalName	Log
Vendor	com.sun.media.jai
Description	Computes the natural logarithm of the pixel values of an image.
DocURL	http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/LogDescriptor.html
Version	1.0

No parameters are needed for the "Log" 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

LogDescriptor()
Constructor.

Method Summary

static RenderedOp	create(RenderedImage source0, RenderingHints hints) Computes the natural logarithm of the pixel values of an image.
static RenderableOp	createRenderable(RenderableImage source0, RenderingHints hints) Computes the natural logarithm of the pixel values of an 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

LogDescriptor

public LogDescriptor()

Constructor.

Method Detail

isRenderableSupported

public boolean isRenderableSupported()

Returns true since renderable operation is supported.

Overrides:

isRenderableSupported in class OperationDescriptorImpl

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

See Also:

OperationDescriptorImpl.isModeSupported(java.lang.String)

create

public static RenderedOp create(RenderedImage source0,
                                RenderingHints hints)

Computes the natural logarithm of the pixel values of an 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 natural logarithm of the pixel values of an 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