/*
* $RCSfile: AbsoluteDescriptor.java,v $
*
* Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
*
* Use is subject to license terms.
*
* $Revision: 1.1 $
* $Date: 2005/02/11 04:57:28 $
* $State: Exp $
*/
package com.lightcrafts.mediax.jai.operator;
import java.awt.RenderingHints;
import java.awt.image.RenderedImage;
import java.awt.image.renderable.RenderableImage;
import com.lightcrafts.mediax.jai.JAI;
import com.lightcrafts.mediax.jai.OperationDescriptorImpl;
import com.lightcrafts.mediax.jai.ParameterBlockJAI;
import com.lightcrafts.mediax.jai.RenderableOp;
import com.lightcrafts.mediax.jai.RenderedOp;
import com.lightcrafts.mediax.jai.registry.RenderableRegistryMode;
import com.lightcrafts.mediax.jai.registry.RenderedRegistryMode;
/**
* An <code>OperationDescriptor</code> describing the "Absolute" operation.
*
* <p> The "Absolute" operation takes a single rendered or renderable
* source image, and computes the mathematical absolute value of each pixel:
*
* <pre>
* if (src[x][y][b] < 0) {
* dst[x][y][b] = -src[x][y][b];
* } else {
* dst[x][y][b] = src[x][y][b];
* }
* </pre>
*
* <p> For signed integral data types, the smallest value of the data
* type does not have a positive counterpart; such values will be left
* unchanged. This behavior parallels that of the Java unary minus
* operator (see <i>The Java Language Specification</i>, section
* 15.14.4).
*
* <p><table border=1>
* <caption>Resource List</caption>
* <tr><th>Name</th> <th>Value</th></tr>
* <tr><td>GlobalName</td> <td>Absolute</td></tr>
* <tr><td>LocalName</td> <td>Absolute</td></tr>
* <tr><td>Vendor</td> <td>com.lightcrafts.media.jai</td></tr>
* <tr><td>Description</td> <td>Replaces the pixel values of an image by their absolute values.</td></tr>
* <tr><td>DocURL</td> <td>http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/AbsoluteDescriptor.html</td></tr>
* <tr><td>Version</td> <td>1.0</td></tr>
* </table></p>
*
* <p> No parameters are needed for the "Absolute" operation.
*
* @see com.lightcrafts.mediax.jai.OperationDescriptor
*/
public class AbsoluteDescriptor extends OperationDescriptorImpl {
/**
* The resource strings that provide the general documentation
* and specify the parameter list for this operation.
*/
private static final String[][] resources = {
{"GlobalName", "Absolute"},
{"LocalName", "Absolute"},
{"Vendor", "com.lightcrafts.media.jai"},
{"Description", JaiI18N.getString("AbsoluteDescriptor0")},
{"DocURL", "http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/AbsoluteDescriptor.html"},
{"Version", JaiI18N.getString("DescriptorVersion")}
};
/** Constructor. */
public AbsoluteDescriptor() {
super(resources, 1, null, null, null);
}
/** Returns <code>true</code> since renderable operation is supported. */
public boolean isRenderableSupported() {
return true;
}
/**
* Replaces the pixel values of an image by their absolute values.
*
* <p>Creates a <code>ParameterBlockJAI</code> from all
* supplied arguments except <code>hints</code> and invokes
* {@link JAI#create(String,ParameterBlock,RenderingHints)}.
*
* @see JAI
* @see ParameterBlockJAI
* @see RenderedOp
*
* @param source0 <code>RenderedImage</code> source 0.
* @param hints The <code>RenderingHints</code> to use.
* May be <code>null</code>.
* @return The <code>RenderedOp</code> destination.
* @throws IllegalArgumentException if <code>source0</code> is <code>null</code>.
*/
public static RenderedOp create(RenderedImage source0,
RenderingHints hints) {
ParameterBlockJAI pb =
new ParameterBlockJAI("Absolute",
RenderedRegistryMode.MODE_NAME);
pb.setSource("source0", source0);
return JAI.create("Absolute", pb, hints);
}
/**
* Replaces the pixel values of an image by their absolute values.
*
* <p>Creates a <code>ParameterBlockJAI</code> from all
* supplied arguments except <code>hints</code> and invokes
* {@link JAI#createRenderable(String,ParameterBlock,RenderingHints)}.
*
* @see JAI
* @see ParameterBlockJAI
* @see RenderableOp
*
* @param source0 <code>RenderableImage</code> source 0.
* @param hints The <code>RenderingHints</code> to use.
* May be <code>null</code>.
* @return The <code>RenderableOp</code> destination.
* @throws IllegalArgumentException if <code>source0</code> is <code>null</code>.
*/
public static RenderableOp createRenderable(RenderableImage source0,
RenderingHints hints) {
ParameterBlockJAI pb =
new ParameterBlockJAI("Absolute",
RenderableRegistryMode.MODE_NAME);
pb.setSource("source0", source0);
return JAI.createRenderable("Absolute", pb, hints);
}
}