Package org.apache.sis.referencing.operation.transform

Class AbstractMathTransform1D.Inverse

Object

FormattableObject

AbstractMathTransform

AbstractMathTransform.Inverse

Inverse

All Implemented Interfaces:

Parameterized, Lenient­Comparable, Math­Transform, Math­Transform1D

Enclosing class:

AbstractMathTransform1D

protected abstract static class AbstractMathTransform1D.Inverse
extends AbstractMathTransform.Inverse
implements MathTransform1D

Base class for implementation of inverse math transforms. This inner class is the inverse of the enclosing Abstract­Math­Transform1D.

Serialization

This object may or may not be serializable, at implementation choices. Most Apache SIS implementations are serializable, but the serialized objects are not guaranteed to be compatible with future SIS versions. Serialization should be used only for short term storage or RMI between applications running the same SIS version.

Since:

0.7

Defined in the sis-referencing module

Nested Class Summary

Nested classes/interfaces inherited from class AbstractMathTransform

Abstract­Math­Transform.Inverse

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Inverse()	Constructs an inverse math transform.

Method Summary

Modifier and Type	Method	Description
Matrix	derivative(DirectPosition point)	Gets the derivative of this transform at a point.
abstract MathTransform1D	inverse()	Returns the inverse of this math transform.
Matrix	transform(double[] srcPts, int srcOff, double[] dstPts, int dstOff, boolean derivate)	Transforms a single point in the given array and opportunistically computes its derivative if requested.

Methods inherited from class AbstractMathTransform.Inverse

compute­Hash­Code, equals, format­To, get­Source­Dimensions, get­Target­Dimensions, is­Identity

Methods inherited from class AbstractMathTransform

equals, get­Contextual­Parameters, get­Parameter­Descriptors, get­Parameter­Values, hash­Code, transform, transform, transform, transform, transform, try­Concatenate

Methods inherited from class FormattableObject

print, to­String, to­String, to­WKT

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface MathTransform

get­Source­Dimensions, get­Target­Dimensions, is­Identity, to­WKT, transform, transform, transform, transform, transform

Methods inherited from interface MathTransform1D

derivative, transform

Constructor Detail

Inverse

protected Inverse()

Constructs an inverse math transform.

Method Detail

inverse

public abstract MathTransform1D inverse()

Returns the inverse of this math transform. The returned transform should be the enclosing math transform.

Specified by:

inverse in interface Math­Transform

Specified by:

inverse in interface Math­Transform1D

Specified by:

inverse in class Abstract­Math­Transform.Inverse

Returns:

the inverse of this transform.

transform

public Matrix transform(double[] srcPts,
                        int srcOff,
                        double[] dstPts,
                        int dstOff,
                        boolean derivate)
                 throws TransformException

Transforms a single point in the given array and opportunistically computes its derivative if requested. The default implementation delegates to Math­Transform1D.transform(double) and potentially to Math­Transform1D.derivative(double). Subclasses may override this method for performance reason.

Specified by:

transform in class Abstract­Math­Transform

Parameters:

src­Pts - the array containing the source coordinate (can not be null).

src­Off - the offset to the point to be transformed in the source array.

dst­Pts - the array into which the transformed coordinate is returned. May be the same than src­Pts. May be null if only the derivative matrix is desired.

dst­Off - the offset to the location of the transformed point that is stored in the destination array.

derivate - true for computing the derivative, or false if not needed.

Returns:

the matrix of the transform derivative at the given source position, or null if the derivate argument is false.

Throws:

Transform­Exception - if the point can not be transformed or if a problem occurred while calculating the derivative.

See Also:

Abstract­Math­Transform.derivative(Direct­Position), Abstract­Math­Transform.transform(Direct­Position, Direct­Position), Math­Transforms.derivative­And­Transform(Math­Transform, double[], int, double[], int)

derivative

public Matrix derivative(DirectPosition point)
                  throws TransformException

Gets the derivative of this transform at a point. The default implementation ensures that point is one-dimensional, then delegates to Math­Transform1D.derivative(double).

Specified by:

derivative in interface Math­Transform

Overrides:

derivative in class Abstract­Math­Transform.Inverse

Parameters:

point - the coordinate point where to evaluate the derivative, or null.

Returns:

the derivative at the specified point (never null).

Throws:

Mismatched­Dimension­Exception - if point does not have the expected dimension.

Transform­Exception - if the derivative can not be evaluated at the specified point.