public class TranslateDescriptor
extends OperationDescriptorImpl
OperationDescriptor
describing the "Translate" operation.
The "Translate" operation copies an image to a new location in the plane.
For each pixel (x, y) of the destination, the source value at the position (x - xTrans, y - yTrans) is constructed and written to the destination. Both xTrans and yTrans must be integral, else an exception is thrown. No ROI or No Data are considered, if these features are requested the it.geosolutions.jaiext.scale.ScaleDescriptor should be used.
It may be noted that the minX, minY, width and height hints as specified through the JAI.KEY_IMAGE_LAYOUT
hint in the
RenderingHints
object are not honored, as this operator calculates the destination image bounds itself. The other
ImageLayout
hints, like tileWidth and tileHeight, however are honored.
It should be noted that this operation automatically adds a value of Boolean.TRUE
for the
JAI.KEY_REPLACE_INDEX_COLOR_MODEL
to the given configuration
so that the operation is performed on the pixel values
instead of being performed on the indices into the color map if the source(s) have an IndexColorModel
. This addition will take place
only if a value for the JAI.KEY_REPLACE_INDEX_COLOR_MODEL
has not already been provided by the user. Note that the
configuration
Map is cloned before the new hint is added to it. The operation can be smart about the value of the
JAI.KEY_REPLACE_INDEX_COLOR_MODEL
RenderingHints
, i.e. while the default value for the
JAI.KEY_REPLACE_INDEX_COLOR_MODEL
is Boolean.TRUE
, in some cases the operator could set the default.
"Translate" defines a PropertyGenerator that performs an identical transformation on the "ROI" property of the source image, which can be retrieved
by calling the getProperty
method with "ROI" as the property name.
Name | Value |
---|---|
GlobalName | Translate |
LocalName | Translate |
Vendor | it.geosolutions.jaiext |
Description | Translate an Image on the X and Y axes. |
DocURL | http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/TranslateDescriptor.html |
Version | 1.0 |
arg0Desc | The X translation value. |
arg1Desc | The Y translation value. |
Name | Class Type | Default Value |
---|---|---|
xTrans | java.lang.Float | 0.0F |
yTrans | java.lang.Float | 0.0F |
Interpolation
,
OperationDescriptor
,
Serialized FormConstructor and Description |
---|
TranslateDescriptor() |
Modifier and Type | Method and Description |
---|---|
static RenderedOp |
create(RenderedImage source0,
Float xTrans,
Float yTrans,
Interpolation interpolation,
RenderingHints hints)
Translate an image to a new location.
|
PropertyGenerator[] |
getPropertyGenerators()
Returns an array of
PropertyGenerators implementing
property inheritance for the "Translate" operation |
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, validateSources
public PropertyGenerator[] getPropertyGenerators()
PropertyGenerators
implementing
property inheritance for the "Translate" operationgetPropertyGenerators
in interface OperationDescriptor
getPropertyGenerators
in class OperationDescriptorImpl
public static RenderedOp create(RenderedImage source0, Float xTrans, Float yTrans, Interpolation interpolation, RenderingHints hints)
Creates a ParameterBlockJAI
from all supplied arguments except hints
and invokes
JAI.create(String,ParameterBlock,RenderingHints)
.
source0
- RenderedImage
source 0.xTrans
- The displacement in X direction. May be null
.yTrans
- The displacement in Y direction. May be null
.hints
- The RenderingHints
to use. May be null
.RenderedOp
destination.IllegalArgumentException
- if source0
is null
.JAI
,
ParameterBlockJAI
,
RenderedOp
Copyright © 2006–2018 GeoSolutions. All rights reserved.