Module org.apache.sis.referencing

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

Class AbstractMathTransform.Inverse

Object

FormattableObject

AbstractMathTransform

Inverse

All Implemented Interfaces:

Parameterized, Lenient­Comparable, Math­Transform

Direct Known Subclasses:

Abstract­Math­Transform1D.Inverse, Abstract­Math­Transform2D.Inverse

Enclosing class:

Abstract­Math­Transform

protected abstract static class AbstractMathTransform.Inverse
extends AbstractMathTransform

Base class for implementations of inverse math transforms. Subclasses need to implement the inverse() method.

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.5

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
protected int	compute­Hash­Code()	Computes a hash value for this transform.
Matrix	derivative(Direct­Position point)	Gets the derivative of this transform at a point.
boolean	equals(Object object, Comparison­Mode mode)	Compares the specified object with this inverse math transform for equality.
protected String	format­To(Formatter formatter)	Formats the inner part of a Well Known Text version 1 (WKT 1) element.
Optional<Envelope>	get­Domain(Domain­Definition criteria)	Returns the ranges of coordinate values which can be used as inputs.
int	get­Source­Dimensions()	Gets the dimension of input points.
int	get­Target­Dimensions()	Gets the dimension of output points.
abstract Math­Transform	inverse()	Returns the inverse of this math transform.
boolean	is­Identity()	Tests whether this transform does not move any points.

Methods inherited from class AbstractMathTransform

equals, get­Contextual­Parameters, get­Parameter­Descriptors, get­Parameter­Values, hash­Code, transform, 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

to­WKT

Constructor Details

Inverse

protected Inverse()

Constructs an inverse math transform.

Method Details

getSourceDimensions

public int getSourceDimensions()

Gets the dimension of input points. The default implementation returns the dimension of output points of the inverse math transform.

Specified by:

get­Source­Dimensions in interface Math­Transform

Specified by:

get­Source­Dimensions in class Abstract­Math­Transform

Returns:

the number of dimensions of input points.

See Also:

• Default­Operation­Method.get­Source­Dimensions()

getTargetDimensions

public int getTargetDimensions()

Gets the dimension of output points. The default implementation returns the dimension of input points of the inverse math transform.

Specified by:

get­Target­Dimensions in interface Math­Transform

Specified by:

get­Target­Dimensions in class Abstract­Math­Transform

Returns:

the number of dimensions of output points.

See Also:

• Default­Operation­Method.get­Target­Dimensions()

getDomain

public Optional<Envelope> getDomain(DomainDefinition criteria)
                             throws TransformException

Returns the ranges of coordinate values which can be used as inputs. The default implementation invokes inverse().get­Domain(criteria) and transforms the returned envelope.

Overrides:

get­Domain in class Abstract­Math­Transform

Parameters:

criteria - controls the definition of transform domain.

Returns:

estimation of a domain where this transform is considered numerically applicable.

Throws:

Transform­Exception - if the domain cannot be estimated.

Since:

1.3

See Also:

• Math­Transforms.get­Domain(Math­Transform)
• Coordinate­Operation.get­Domain­Of­Validity()

derivative

public Matrix derivative(DirectPosition point)
                  throws TransformException

Gets the derivative of this transform at a point. The default implementation computes the inverse of the matrix returned by the inverse math transform.

Specified by:

derivative in interface Math­Transform

Overrides:

derivative in class Abstract­Math­Transform

Parameters:

point - the coordinate tuple where to evaluate the derivative.

Returns:

the derivative at the specified point (never null).

Throws:

Null­Pointer­Exception - if the derivative depends on coordinates and point is null.

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

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

inverse

public abstract MathTransform inverse()

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

Specified by:

inverse in interface Math­Transform

Overrides:

inverse in class Abstract­Math­Transform

Returns:

the inverse of this transform.

isIdentity

public boolean isIdentity()

Tests whether this transform does not move any points. The default implementation delegates this tests to the inverse math transform.

Specified by:

is­Identity in interface Math­Transform

Overrides:

is­Identity in class Abstract­Math­Transform

Returns:

computeHashCode

protected int computeHashCode()

Computes a hash value for this transform. This method is invoked by Abstract­Math­Transform.hash­Code() when first needed.

Overrides:

compute­Hash­Code in class Abstract­Math­Transform

Returns:

the hash code value. This value may change between different execution of the Apache SIS library.

equals

public boolean equals(Object object,
 ComparisonMode mode)

Compares the specified object with this inverse math transform for equality. The default implementation tests if object in an instance of the same class than this, and if so compares their inverse Math­Transform.

Specified by:

equals in interface Lenient­Comparable

Overrides:

equals in class Abstract­Math­Transform

Parameters:

object - the object to compare with this transform.

mode - the strictness level of the comparison. Default to STRICT.

Returns:

true if the given object is considered equals to this math transform.

See Also:

• Utilities.deep­Equals(Object, Object, Comparison­Mode)

formatTo

protected String formatTo(Formatter formatter)

Formats the inner part of a Well Known Text version 1 (WKT 1) element. If this inverse math transform has any parameter values, then this method formats the WKT as in the super-class method. Otherwise this method formats the math transform as an "Inverse_MT" entity.

Compatibility note

Param_MT and Inverse_MT are defined in the WKT 1 specification only.

Overrides:

format­To in class Abstract­Math­Transform

Parameters:

formatter - the formatter to use.

Returns:

the WKT element name, which is "Param_MT" or "Inverse_MT" in the default implementation.

See Also:

• Default­Math­Transform­Factory.create­From­WKT(String)