Class TranslationTransform
java.lang.Object
org.apache.sis.io.wkt.FormattableObject
org.apache.sis.referencing.operation.transform.AbstractMathTransform
org.apache.sis.referencing.operation.transform.AbstractLinearTransform
org.apache.sis.referencing.operation.transform.TranslationTransform
- All Implemented Interfaces:
Serializable
,ExtendedPrecisionMatrix
,Parameterized
,LinearTransform
,LenientComparable
,org.opengis.referencing.operation.MathTransform
,org.opengis.referencing.operation.Matrix
An affine transform that translate the coordinate values by constant values.
Note: we do not provide two-dimensional specialization because
AffineTransform2D
should be used in such case.- Since:
- 1.0
- Version:
- 1.1
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.referencing.operation.transform.AbstractMathTransform
AbstractMathTransform.Inverse
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final double[]
The error terms in double-double arithmetic, ornull
if none.private final double[]
Translation terms, to be applied in the same order than coordinate values.private static final long
Serial number for inter-operability with different versions.Fields inherited from class org.apache.sis.referencing.operation.transform.AbstractLinearTransform
inverse
Fields inherited from class org.apache.sis.referencing.operation.transform.AbstractMathTransform
MAXIMUM_BUFFER_SIZE, MAXIMUM_FAILURES
Fields inherited from interface org.apache.sis.internal.referencing.ExtendedPrecisionMatrix
IDENTITY, ZERO
-
Constructor Summary
ConstructorsModifierConstructorDescription(package private)
TranslationTransform
(double[] offsets) Constructs a translation transform for the given offset vector.(package private)
TranslationTransform
(int dimension, double offset) Constructs an uniform translation transform for the given offset applied on all dimensions.(package private)
TranslationTransform
(int size, double[] elements) Constructs a translation transform from a matrix having the given elements.private
Creates a transform as the inverse of the given transform. -
Method Summary
Modifier and TypeMethodDescriptionprotected int
Computes a hash value for this transform.(package private) final LinearTransform
Invoked byAbstractLinearTransform.inverse()
the first time that the inverse transform needs to be computed.org.opengis.referencing.operation.Matrix
derivative
(org.opengis.geometry.DirectPosition point) Gets the derivative of this transform at a point.protected boolean
equalsSameClass
(Object object) Compares this math transform with an object which is known to be an instance of the same class.double
getElement
(int row, int column) Returns the matrix element at the given index.double[]
Returns a copy of matrix elements, including error terms if any.int
Gets the dimension of input points.int
Gets the dimension of output points.boolean
Tests whether this transform does not move any points.private static double[]
negate
(double[] array) Returns a new array with negative values of given array (can benull
).org.opengis.referencing.operation.Matrix
transform
(double[] srcPts, int srcOff, double[] dstPts, int dstOff, boolean derivate) Converts a single position in a list of coordinate values, and optionally computes the derivative at that location.void
transform
(double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts) Transforms an array of floating point coordinates by this matrix.void
transform
(double[] srcPts, int srcOff, float[] dstPts, int dstOff, int numPts) Transforms an array of floating point coordinates by this matrix.void
transform
(float[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts) Transforms an array of floating point coordinates by this matrix.void
transform
(float[] srcPts, int srcOff, float[] dstPts, int dstOff, int numPts) Transforms an array of floating point coordinates by this matrix.Methods inherited from class org.apache.sis.referencing.operation.transform.AbstractLinearTransform
clone, deltaTransform, equals, getMatrix, getNumCol, getNumRow, getParameterDescriptors, getParameterValues, inverse, isAffine, setElement, toString, tryConcatenate
Methods inherited from class org.apache.sis.referencing.operation.transform.AbstractMathTransform
beforeFormat, equals, formatTo, getContextualParameters, getDomain, hashCode, isInverseEquals, mismatchedDimension, transform
Methods inherited from class org.apache.sis.io.wkt.FormattableObject
print, toString, toWKT
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.opengis.referencing.operation.MathTransform
toWKT, transform
Methods inherited from interface org.opengis.referencing.operation.Matrix
clone, getNumCol, getNumRow, setElement
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
offsets
private final double[] offsetsTranslation terms, to be applied in the same order than coordinate values. The length of this array is the number of target dimensions. -
errors
private final double[] errorsThe error terms in double-double arithmetic, ornull
if none. May be shorter thanoffsets
if all remaining errors are zero.
-
-
Constructor Details
-
TranslationTransform
TranslationTransform(int dimension, double offset) Constructs an uniform translation transform for the given offset applied on all dimensions. -
TranslationTransform
TranslationTransform(double[] offsets) Constructs a translation transform for the given offset vector. -
TranslationTransform
Creates a transform as the inverse of the given transform. -
TranslationTransform
TranslationTransform(int size, double[] elements) Constructs a translation transform from a matrix having the given elements. This constructors assumes that the matrix is square, affine and contains only translation terms (this is not verified).
-
-
Method Details
-
negate
private static double[] negate(double[] array) Returns a new array with negative values of given array (can benull
). -
getExtendedElements
public double[] getExtendedElements()Returns a copy of matrix elements, including error terms if any.- Specified by:
getExtendedElements
in interfaceExtendedPrecisionMatrix
- Returns:
- a copy of matrix elements, potentially followed by error terms.
-
getSourceDimensions
public int getSourceDimensions()Gets the dimension of input points.- Specified by:
getSourceDimensions
in interfaceorg.opengis.referencing.operation.MathTransform
- Specified by:
getSourceDimensions
in classAbstractMathTransform
- Returns:
- the number of dimensions of input points.
- See Also:
-
getTargetDimensions
public int getTargetDimensions()Gets the dimension of output points.- Specified by:
getTargetDimensions
in interfaceorg.opengis.referencing.operation.MathTransform
- Specified by:
getTargetDimensions
in classAbstractMathTransform
- Returns:
- the number of dimensions of output points.
- See Also:
-
getElement
public double getElement(int row, int column) Returns the matrix element at the given index.- Specified by:
getElement
in interfaceorg.opengis.referencing.operation.Matrix
-
isIdentity
public boolean isIdentity()Tests whether this transform does not move any points.- Specified by:
isIdentity
in interfaceorg.opengis.referencing.operation.MathTransform
- Specified by:
isIdentity
in interfaceorg.opengis.referencing.operation.Matrix
- Overrides:
isIdentity
in classAbstractMathTransform
-
transform
public org.opengis.referencing.operation.Matrix transform(double[] srcPts, int srcOff, double[] dstPts, int dstOff, boolean derivate) Converts a single position in a list of coordinate values, and optionally computes the derivative at that location.- Specified by:
transform
in classAbstractMathTransform
- Parameters:
srcPts
- the array containing the source coordinates (cannot benull
).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 thansrcPts
. May benull
if only the derivative matrix is desired.dstOff
- the offset to the location of the transformed point that is stored in the destination array.derivate
-true
for computing the derivative, orfalse
if not needed.- Returns:
- the matrix of the transform derivative at the given source position,
or
null
if thederivate
argument isfalse
. - See Also:
-
transform
public void transform(double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts) Transforms an array of floating point coordinates by this matrix. Point coordinates must have a dimension equal to
. For example, for square matrix of size 4×4, coordinate points are three-dimensional and stored in the arrays starting at the specified offset (Matrix.getNumCol()
-1srcOff
) in the order[x₀, y₀, z₀, x₁, y₁, z₁..., xn, yn, zn]
.- Specified by:
transform
in interfaceorg.opengis.referencing.operation.MathTransform
- Overrides:
transform
in classAbstractMathTransform
- 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. The source and destination array sections can overlap.numPts
- the number of points to be transformed.
-
transform
public void transform(float[] srcPts, int srcOff, float[] dstPts, int dstOff, int numPts) Transforms an array of floating point coordinates by this matrix. Point coordinates must have a dimension equal to
. For example, for square matrix of size 4×4, coordinate points are three-dimensional and stored in the arrays starting at the specified offset (Matrix.getNumCol()
- 1srcOff
) in the order[x₀, y₀, z₀, x₁, y₁, z₁..., xn, yn, zn]
.- Specified by:
transform
in interfaceorg.opengis.referencing.operation.MathTransform
- Overrides:
transform
in classAbstractMathTransform
- 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. The source and destination array sections can overlap.numPts
- the number of points to be transformed.
-
transform
public void transform(double[] srcPts, int srcOff, float[] dstPts, int dstOff, int numPts) Transforms an array of floating point coordinates by this matrix.- Specified by:
transform
in interfaceorg.opengis.referencing.operation.MathTransform
- Overrides:
transform
in classAbstractMathTransform
- 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 points to be transformed.
-
transform
public void transform(float[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts) Transforms an array of floating point coordinates by this matrix.- Specified by:
transform
in interfaceorg.opengis.referencing.operation.MathTransform
- Overrides:
transform
in classAbstractMathTransform
- 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 points to be transformed.
-
derivative
public org.opengis.referencing.operation.Matrix derivative(org.opengis.geometry.DirectPosition point) Gets the derivative of this transform at a point. For a matrix transform, the derivative is the same everywhere.- Specified by:
derivative
in interfaceorg.opengis.referencing.operation.MathTransform
- Overrides:
derivative
in classAbstractMathTransform
- Parameters:
point
- ignored (can benull
).- Returns:
- the derivative at the specified point (never
null
).
-
createInverse
Invoked byAbstractLinearTransform.inverse()
the first time that the inverse transform needs to be computed.- Overrides:
createInverse
in classAbstractLinearTransform
-
computeHashCode
protected int computeHashCode()Computes a hash value for this transform. This method is invoked byAbstractMathTransform.hashCode()
when first needed.- Overrides:
computeHashCode
in classAbstractMathTransform
- Returns:
- the hash code value. This value may change between different execution of the Apache SIS library.
-
equalsSameClass
Compares this math transform with an object which is known to be an instance of the same class.- Specified by:
equalsSameClass
in classAbstractLinearTransform
- Parameters:
object
- the object to compare with this transform.- Returns:
true
if the given object is considered equals to this math transform.
-