org.cts.op

Class IterativeTransformation

java.lang.Object

org.cts.IdentifiableComponent

org.cts.op.AbstractCoordinateOperation

org.cts.op.IterativeTransformation

All Implemented Interfaces:

Identifiable, CoordinateOperation

public class IterativeTransformation
extends AbstractCoordinateOperation
implements CoordinateOperation

The IterativeTransformation is used to repeat a CoordinateOperation until one or more coordinate(s) converge to predifined values (saved in additional dimensions using MemorizeCoordinate). This transformation should be used when an iterative process is recommended (for instance when using a grid using longitude and latitude calculated by a first approximate transformation.

Author:

Jules Party

Field Summary

Fields inherited from class org.cts.op.AbstractCoordinateOperation

precision

Fields inherited from interface org.cts.Identifiable

DEFAULT, LOCAL, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
IterativeTransformation(CoordinateOperation op, int[] realValueIndex, int[] calculatedValueIndex, double[] tol, int maxIterations) Build a new IterativeTransformation.

Method Summary

Modifier and Type	Method and Description
double	getPrecision() Returns the precision of the transformation.
String	toString() Returns a String representation of this identifier.
double[]	transform(double[] coord) Return a double[] representing the same location as coord but in another CoordinateReferenceSystem.

Methods inherited from class org.cts.op.AbstractCoordinateOperation

inverse, isIdentity

Methods inherited from class org.cts.IdentifiableComponent

addAlias, addRemark, equals, getAliases, getAuthorityKey, getAuthorityName, getCode, getComponent, getIdentifier, getName, getRemarks, getShortName, hashCode, setIdentifier, setRemarks, setShortName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cts.op.CoordinateOperation

inverse, isIdentity

Methods inherited from interface org.cts.Identifiable

addAlias, addRemark, getAliases, getAuthorityKey, getAuthorityName, getCode, getName, getRemarks, getShortName, setRemarks, setShortName

Constructor Detail

IterativeTransformation

public IterativeTransformation(CoordinateOperation op,
                               int[] realValueIndex,
                               int[] calculatedValueIndex,
                               double[] tol,
                               int maxIterations)
                        throws Exception

Build a new IterativeTransformation.

Parameters:

op - the transformation to iterate

realValueIndex - a list of indexes referring to the reference values the iteration should reach

calculatedValueIndex - the list of indexes referring to the calculated values that must reach the reference values defined above

tol - the maximal difference accepted between the real value and the target value

Throws:

Exception - when the arrays in parameter does not have the same length

Method Detail

transform

public double[] transform(double[] coord)
                   throws IllegalCoordinateException,
                          CoordinateOperationException

Description copied from class: AbstractCoordinateOperation

Return a double[] representing the same location as coord but in another CoordinateReferenceSystem.

Specified by:

transform in interface CoordinateOperation

Specified by:

transform in class AbstractCoordinateOperation

Parameters:

coord - the input coordinate

Returns:

a double array containing the output coordinate

Throws:

IllegalCoordinateException - if coord is not compatible with this CoordinateOperation.

CoordinateOperationException - if this operation failed during the transformation process.

getPrecision

public double getPrecision()

Description copied from class: AbstractCoordinateOperation

Returns the precision of the transformation.

Precision is a double representing the mean error, in meters made on the position resulting from this CoordinateOperation.

ex. : 0.001 means that the precision of the resulting position is about one millimeter

Default precision (or maximum precision) is considered to be equals to 1E-9 which is the value of an ulp (units in the last place) for a double value equals to 6378137.0 (Earth semi-major axis).

Specified by:

getPrecision in interface CoordinateOperation

Overrides:

getPrecision in class AbstractCoordinateOperation

toString

public String toString()

Description copied from class: IdentifiableComponent

Returns a String representation of this identifier.

Overrides:

toString in class IdentifiableComponent