org.geotools.referencing.operation.transform

Class MathTransformProxy

Object

MathTransformProxy

All Implemented Interfaces:

Serializable, MathTransform

Direct Known Subclasses:

MathTransformProvider.Delegate

public class MathTransformProxy
extends Object
implements MathTransform, Serializable

A math transform which delegates part of its work to an other math transform. This is used as a starting point for subclass wanting to modifies only some aspect of an existing math transform, or to attach additional informations to it. The default implementation delegates all method calls to the underlying transform. Subclasses typically override some of those methods.

This class is serializable if the underlying transform is serializable too.

Since:

2.2

Author:

Martin Desruisseaux (IRD)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
MathTransform	transform The math transform on which to delegate the work.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MathTransformProxy(MathTransform transform) Creates a new proxy which delegates its work to the specified math transform.

Method Summary

Modifier and Type	Method and Description
Matrix	derivative(DirectPosition point) Gets the derivative of this transform at a point.
boolean	equals(Object object) Compares the specified object with this inverse math transform for equality.
int	getSourceDimensions() Gets the dimension of input points.
int	getTargetDimensions() Gets the dimension of output points.
int	hashCode() Returns a hash code value for this math transform.
MathTransform	inverse() Returns the inverse of this math transform.
boolean	isIdentity() Tests whether this transform does not move any points.
String	toString() Returns a string representation for this transform.
String	toWKT() Returns a Well Known Text (WKT) for this transform.
DirectPosition	transform(DirectPosition ptSrc, DirectPosition ptDst) Transforms the specified ptSrc and stores the result in ptDst.
void	transform(double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts) Transforms a list of coordinate point ordinal values.
void	transform(double[] srcPts, int srcOff, float[] dstPts, int dstOff, int numPts) Transforms a list of coordinate point ordinal values.
void	transform(float[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts) Transforms a list of coordinate point ordinal values.
void	transform(float[] srcPts, int srcOff, float[] dstPts, int dstOff, int numPts) Transforms a list of coordinate point ordinal values.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

transform

public final MathTransform transform

The math transform on which to delegate the work.

Constructor Detail

MathTransformProxy

protected MathTransformProxy(MathTransform transform)

Creates a new proxy which delegates its work to the specified math transform.

Parameters:

transform - The transform on which to delegate the work.

Method Detail

getSourceDimensions

public int getSourceDimensions()

Gets the dimension of input points.

Specified by:

getSourceDimensions in interface MathTransform

Returns:

The dimension of input points.

getTargetDimensions

public int getTargetDimensions()

Gets the dimension of output points.

Specified by:

getTargetDimensions in interface MathTransform

Returns:

The dimension of output points.

transform

public DirectPosition transform(DirectPosition ptSrc,
                                DirectPosition ptDst)
                         throws MismatchedDimensionException,
                                TransformException

Transforms the specified ptSrc and stores the result in ptDst.

Specified by:

transform in interface MathTransform

Parameters:

ptSrc - the specified coordinate point to be transformed.

ptDst - the specified coordinate point that stores the result of transforming ptSrc, or null.

Returns:

the coordinate point after transforming ptSrc and storing the result in ptDst, or a newly created point if ptDst was null.

Throws:

MismatchedDimensionException - if ptSrc or ptDst doesn't have the expected dimension.

TransformException - if the point can't be transformed.

transform

public void transform(double[] srcPts,
                      int srcOff,
                      double[] dstPts,
                      int dstOff,
                      int numPts)
               throws TransformException

Transforms a list of coordinate point ordinal values.

Specified by:

transform in interface MathTransform

Parameters:

srcPts - the array containing the source point coordinates.

srcOff - the offset to the first point to be transformed in the source array.

dstPts - the array into which the transformed point coordinates are returned. May be the same than srcPts.

dstOff - the offset to the location of the first transformed point that is stored in the destination array.

numPts - the number of point objects to be transformed.

Throws:

TransformException - if a point can't be transformed. Some implementations will stop at the first failure, wile some other implementations will fill the untransformable points with NaN values, continue and throw the exception only at end. Implementations that fall in the later case should set the last completed transform to this.

transform

public void transform(float[] srcPts,
                      int srcOff,
                      float[] dstPts,
                      int dstOff,
                      int numPts)
               throws TransformException

Transforms a list of coordinate point ordinal values.

Specified by:

transform in interface MathTransform

Parameters:

srcPts - the array containing the source point coordinates.

srcOff - the offset to the first point to be transformed in the source array.

dstPts - the array into which the transformed point coordinates are returned. May be the same than srcPts.

dstOff - the offset to the location of the first transformed point that is stored in the destination array.

numPts - the number of point objects to be transformed.

Throws:

TransformException - if a point can't be transformed. Some implementations will stop at the first failure, wile some other implementations will fill the untransformable points with NaN values, continue and throw the exception only at end. Implementations that fall in the later case should set the last completed transform to this.

transform

public void transform(float[] srcPts,
                      int srcOff,
                      double[] dstPts,
                      int dstOff,
                      int numPts)
               throws TransformException

Transforms a list of coordinate point ordinal values.

Specified by:

transform in interface MathTransform

Parameters:

srcPts - the array containing the source point coordinates.

srcOff - the offset to the first point to be transformed in the source array.

dstPts - the array into which the transformed point coordinates are returned.

dstOff - the offset to the location of the first transformed point that is stored in the destination array.

numPts - the number of point objects to be transformed.

Throws:

TransformException - if a point can't be transformed. Some implementations will stop at the first failure, wile some other implementations will fill the untransformable points with NaN values, continue and throw the exception only at end. Implementations that fall in the later case should set the last completed transform to this.

transform

public void transform(double[] srcPts,
                      int srcOff,
                      float[] dstPts,
                      int dstOff,
                      int numPts)
               throws TransformException

Transforms a list of coordinate point ordinal values.

Specified by:

transform in interface MathTransform

Parameters:

srcPts - the array containing the source point coordinates.

srcOff - the offset to the first point to be transformed in the source array.

dstPts - the array into which the transformed point coordinates are returned.

dstOff - the offset to the location of the first transformed point that is stored in the destination array.

numPts - the number of point objects to be transformed.

Throws:

TransformException - if a point can't be transformed. Some implementations will stop at the first failure, wile some other implementations will fill the untransformable points with NaN values, continue and throw the exception only at end. Implementations that fall in the later case should set the last completed transform to this.

derivative

public Matrix derivative(DirectPosition point)
                  throws TransformException

Gets the derivative of this transform at a point.

Specified by:

derivative in interface MathTransform

Parameters:

point - The coordinate point where to evaluate the derivative. Null value is accepted only if the derivative is the same everywhere. For example affine transform accept null value since they produces identical derivative no matter the coordinate value. But most map projection will requires a non-null value.

Returns:

The derivative at the specified point (never null). This method never returns an internal object: changing the matrix will not change the state of this math transform.

Throws:

TransformException - if the derivative can't be evaluated at the specified point.

inverse

public MathTransform inverse()
                      throws NoninvertibleTransformException

Returns the inverse of this math transform.

Specified by:

inverse in interface MathTransform

Returns:

The inverse transform.

Throws:

NoninvertibleTransformException - if the transform can't be inversed.

isIdentity

public boolean isIdentity()

Tests whether this transform does not move any points.

Specified by:

isIdentity in interface MathTransform

Returns:

true if this MathTransform is an identity transform; false otherwise.

toWKT

public String toWKT()
             throws UnsupportedOperationException

Returns a Well Known Text (WKT) for this transform.

Specified by:

toWKT in interface MathTransform

Returns:

The Well Known Text (WKT) for this object.

Throws:

UnsupportedOperationException - If this object can't be formatted as WKT.

toString

public String toString()

Returns a string representation for this transform.

Overrides:

toString in class Object

equals

public boolean equals(Object object)

Compares the specified object with this inverse math transform for equality.

Overrides:

equals in class Object

Parameters:

object - The object to compare with this transform.

Returns:

true if the given object is of the same class and if the wrapped transforms are equal.

hashCode

public int hashCode()

Returns a hash code value for this math transform.

Overrides:

hashCode in class Object