Class InterpolatedTransform
- All Implemented Interfaces:
- Serializable,- Parameterized,- LenientComparable,- MathTransform
DatumShiftGrid.getTranslationDimensions().
 Input and output coordinates
First, "real world" input coordinates (x,y) are converted to grid coordinates (gridX, gridY), which are zero-based indices in the two-dimensional grid. This conversion is applied by an affine transform before to be passed to thetransform methods of this InterpolatedTransform class.
 Translation vectors are stored in the datum shift grid at the specified grid indices. If the grid indices are non-integer values, then the translations are interpolated using a bilinear interpolation. If the grid indices are outside the grid domain ([0 … width-1] × [0 … height-1] where width and height are the number of columns and rows in the grid), then the translations are extrapolated. The translation is finally added to the input coordinates.
The input and output coordinates can have any number of dimensions, provided that they are the same than the number of translation dimensions. However, current implementation uses only the two first dimensions for interpolations in the grid.
- Since:
- 0.7
- See Also:
Defined in the sis-referencing module
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedInterpolatedTransform(DatumShiftGrid<T, T> grid) Creates a transform for the given interpolation grid.
- 
Method SummaryModifier and TypeMethodDescriptionprotected intComputes a hash value for this transform.static <T extends Quantity<T>>
 MathTransformcreateGeodeticTransformation(MathTransformFactory factory, DatumShiftGrid<T, T> grid) Creates a transformation between two geodetic CRS.booleanequals(Object object, ComparisonMode mode) Compares the specified object with this math transform for equality.final DatumShiftGrid<?,?> Returns the grid of datum shifts specified at construction time.final intReturns the number of input dimensions.final intReturns the number of target dimensions.inverse()Returns the inverse of this interpolated transform.transform(double[] srcPts, int srcOff, double[] dstPts, int dstOff, boolean derivate) Applies the datum shift on a coordinate tuple and optionally returns the derivative at that location.voidtransform(double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts) Transforms an arbitrary number of coordinate tuples.Methods inherited from class DatumShiftTransformgetContextualParameters, getParameterValuesMethods inherited from class AbstractMathTransformderivative, equals, formatTo, getDomain, getParameterDescriptors, hashCode, isIdentity, transform, transform, transform, transform, tryConcatenateMethods inherited from class FormattableObjectprint, toString, toString, toWKTMethods inherited from class Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface MathTransformtoWKT
- 
Constructor Details- 
InterpolatedTransformCreates a transform for the given interpolation grid. ThisInterpolatedTransformclass works with coordinate values in units of grid cell For example, input coordinates (4,5) is the position of the center of the cell at grid index (4,5). The output units are the same than the input units.For converting geodetic coordinates, InterpolatedTransforminstances need to be concatenated with the following affine transforms:- Normalization before InterpolatedTransformfor converting the geodetic coordinates into grid coordinates.
- Denormalization after InterpolatedTransformfor converting grid coordinates into geodetic coordinates.
 InterpolatedTransformconstruction, the full conversion chain including the above affine transforms can be created byDatumShiftTransform.getContextualParameters().completeTransform(factory, this)}.- Type Parameters:
- T- dimension of the coordinate tuples and the translation unit.
- Parameters:
- grid- the grid of datum shifts from source to target datum.
- Throws:
- NoninvertibleMatrixException- if the conversion from geodetic coordinates to grid indices cannot be inverted.
- See Also:
 
- Normalization before 
 
- 
- 
Method Details- 
createGeodeticTransformationpublic static <T extends Quantity<T>> MathTransform createGeodeticTransformation(MathTransformFactory factory, DatumShiftGrid<T, T> grid) throws FactoryExceptionCreates a transformation between two geodetic CRS. This factory method combines theInterpolatedTransforminstance with the steps needed for converting values between geodetic and grid coordinates.Unit of measurementThe unit of measurement is determined byDatumShiftGrid.getCoordinateUnit():- If the datum shift unit is angular, then the transform will work with input and output coordinates in degrees of angle.
- If the datum shift unit is linear, then the transform will work with input and output coordinates in metres.
- If the datum shift unit is temporal, then the transform will work with input and output coordinates in seconds.
- Generally for all units other than angular, the transform will work with input and output
       coordinates in the unit given by Unit.getSystemUnit().
 - Type Parameters:
- T- dimension of the coordinate tuples and the translation unit.
- Parameters:
- factory- the factory to use for creating the transform.
- grid- the grid of datum shifts from source to target datum. The- DatumShiftGrid.interpolateInCell(…)method shall compute translations from source to target as ratio of offsets divided by cell sizes.
- Returns:
- the transformation between geodetic coordinates.
- Throws:
- FactoryException- if an error occurred while creating a transform.
 
- 
getShiftGridReturns the grid of datum shifts specified at construction time.- Returns:
- the grid of datum shifts from source to target datum.
- Since:
- 1.1
 
- 
getSourceDimensionspublic final int getSourceDimensions()Returns the number of input dimensions. This fixed toDatumShiftGrid.getTranslationDimensions().- Specified by:
- getSourceDimensionsin interface- MathTransform
- Specified by:
- getSourceDimensionsin class- AbstractMathTransform
- Returns:
- the dimension of input points.
- See Also:
 
- 
getTargetDimensionspublic final int getTargetDimensions()Returns the number of target dimensions. This fixed toDatumShiftGrid.getTranslationDimensions().- Specified by:
- getTargetDimensionsin interface- MathTransform
- Specified by:
- getTargetDimensionsin class- AbstractMathTransform
- Returns:
- the dimension of output points.
- See Also:
 
- 
transformpublic Matrix transform(double[] srcPts, int srcOff, double[] dstPts, int dstOff, boolean derivate) throws TransformException Applies the datum shift on a coordinate tuple and optionally returns the derivative at that location.- Specified by:
- transformin class- AbstractMathTransform
- Parameters:
- srcPts- the array containing the source coordinates (cannot be- null).
- srcOff- the offset to the point to be transformed in the source array.
- dstPts- the array into which the transformed coordinates is returned. May be the same than- srcPts. May be- nullif only the derivative matrix is desired.
- dstOff- the offset to the location of the transformed point that is stored in the destination array.
- derivate-- truefor computing the derivative, or- falseif not needed.
- Returns:
- the matrix of the transform derivative at the given source position,
         or nullif thederivateargument isfalse.
- Throws:
- TransformException- if the point cannot be transformed or if a problem occurred while calculating the derivative.
- See Also:
 
- 
transformpublic void transform(double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts) throws TransformException Transforms an arbitrary number of coordinate tuples.- Specified by:
- transformin interface- MathTransform
- Overrides:
- transformin class- AbstractMathTransform
- 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 cannot be transformed.
 
- 
inverseReturns the inverse of this interpolated transform. The source ellipsoid of the returned transform will be the target ellipsoid of this transform, and conversely.- Specified by:
- inversein interface- MathTransform
- Overrides:
- inversein class- AbstractMathTransform
- Returns:
- a transform from the target ellipsoid to the source ellipsoid of this transform.
 
- 
computeHashCodeprotected int computeHashCode()Computes a hash value for this transform. This method is invoked byAbstractMathTransform.hashCode()when first needed.- Overrides:
- computeHashCodein class- DatumShiftTransform
- Returns:
- the hash code value. This value may change between different execution of the Apache SIS library.
 
- 
equalsCompares the specified object with this math transform for equality.- Specified by:
- equalsin interface- LenientComparable
- Overrides:
- equalsin class- DatumShiftTransform
- Parameters:
- object- the object to compare with this transform.
- mode- the strictness level of the comparison. Default to- STRICT.
- Returns:
- trueif the given object is considered equals to this math transform.
- See Also:
 
 
-