Class AbstractMathTransform1D.Inverse

Object

FormattableObject

AbstractMathTransform

AbstractMathTransform.Inverse

Inverse

All Implemented Interfaces:

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

Enclosing class:

Abstract­Math­Transform1D

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

Nested Class Summary

Nested classes/interfaces inherited from class AbstractMathTransform

Abstract­Math­Transform.Inverse

Modifier and Type	Class	Description
protected static class	Abstract­Math­Transform.Inverse	Base class for implementations of inverse math transforms.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Matrix	derivative(Direct­Position point)	Gets the derivative of this transform at a point.
abstract Math­Transform1D	inverse()	Returns the inverse of this math transform.
Matrix	transform(double[] src­Pts, int src­Off, double[] dst­Pts, int dst­Off, 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­Domain, get­Source­Dimensions, get­Target­Dimensions, is­Identity

Modifier and Type	Method	Description
protected int	compute­Hash­Code()	Computes a hash value for this transform.
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.
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, get­Standard­Type, hash­Code, transform, transform, transform, transform, transform, try­Concatenate

Modifier and Type	Method	Description
final boolean	equals(Object object)	Compares the specified object with this math transform for strict equality.
protected Contextual­Parameters	get­Contextual­Parameters()	Returns the parameters for a sequence of normalize → this → denormalize transforms (optional operation).
Parameter­Descriptor­Group	get­Parameter­Descriptors()	Returns the parameter descriptors for this math transform, or null if unknown.
Parameter­Value­Group	get­Parameter­Values()	Returns the parameter values for this math transform, or null if unknown.
final Type	get­Standard­Type()	Returns the class that defines the public properties of this instance.
final int	hash­Code()	Returns a hash value for this transform.
void	transform(double[] src­Pts, int src­Off, double[] dst­Pts, int dst­Off, int num­Pts)	Transforms a list of coordinate tuples.
void	transform(double[] src­Pts, int src­Off, float[] dst­Pts, int dst­Off, int num­Pts)	Transforms a list of coordinate tuples.
void	transform(float[] src­Pts, int src­Off, double[] dst­Pts, int dst­Off, int num­Pts)	Transforms a list of coordinate tuples.
void	transform(float[] src­Pts, int src­Off, float[] dst­Pts, int dst­Off, int num­Pts)	Transforms a list of coordinate tuples.
Direct­Position	transform(Direct­Position pt­Src, Direct­Position pt­Dst)	Transforms the specified pt­Src and stores the result in pt­Dst.
protected void	try­Concatenate(Transform­Joiner context)	Concatenates in an optimized way this math transform with its neighbor, if possible.

Methods inherited from class FormattableObject

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

Modifier and Type	Method	Description
void	print()	Prints a string representation of this object to the standard output stream.
String	to­String()	Returns a Well Known Text (WKT) or an alternative text representation for this object.
String	to­String(Convention convention)	Returns a Well Known Text (WKT) for this object using the specified convention.
String	to­WKT()	Returns a strictly compliant Well Known Text (WKT) using the default convention, symbols and indentation.

Methods inherited from class Object

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

Methods inherited from interface MathTransform

to­WKT

Modifier and Type	Method	Description
String	to­WKT()	Returns a Well Known Text (WKT) for this object.

Methods inherited from interface MathTransform1D

derivative, transform

Modifier and Type	Method	Description
double	derivative(double value)	Gets the derivative of this function at a value.
double	transform(double value)	Transforms the specified value.

Constructor Details

Inverse

protected Inverse()

Constructs an inverse math transform.

Method Details

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 coordinates (cannot be null).

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

dst­Pts - the array into which the transformed coordinates is returned. May be the same as 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 cannot 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 position 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 cannot be evaluated at the specified point.