org.geotoolkit.referencing.operation.provider
Class WarpPolynomial

Object
  FormattableObject
      AbstractIdentifiedObject
          DefaultOperationMethod
              MathTransformProvider
                  WarpPolynomial

All Implemented Interfaces:

Serializable, Formattable, Deprecable, LenientComparable, IdentifiedObject, OperationMethod

@Immutable
public class WarpPolynomial
extends MathTransformProvider

The provider for WarpTransform2D. This provider constructs a JAI WarpPolynomial from a set of polynomial coefficients, and wraps it in a WarpTransform2D object.

The following table summarizes the parameters recognized by this provider. For a more detailed parameter list, see the PARAMETERS constant.

Operation name: WarpPolynomial

Parameter name	Default value
degree	2
xCoeffs
yCoeffs
preScaleX	1
preScaleY	1
postScaleX	1
postScaleY	1

Since:

2.1

Version:

3.20

Author:

Martin Desruisseaux (IRD, Geomatys)

See Also:

Geotk coordinate operations matrix, Serialized Form

Module:

coverage/geotk-coverage (download)

View source code for this class

Field Summary

static ParameterDescriptor<Integer>	DEGREE Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptorGroup	PARAMETERS The group of all parameters expected by this coordinate operation.
static ParameterDescriptor<Float>	POST_SCALE_X Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Float>	POST_SCALE_Y Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Float>	PRE_SCALE_X Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Float>	PRE_SCALE_Y Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<float[]>	X_COEFFS Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<float[]>	Y_COEFFS Deprecated. Invoke PARAMETERS.descriptor(String) instead.

Fields inherited from class DefaultOperationMethod

sourceDimension, targetDimension

Fields inherited from class FormattableObject

EPSG, GEOTIFF, INTERNAL, OGC, SINGLE_LINE

Fields inherited from interface OperationMethod

FORMULA_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

WarpPolynomial()
Creates a provider for warp transforms.

Method Summary

protected MathTransform	createMathTransform(ParameterValueGroup values) Creates a warp transform from the specified group of parameter values.
Class<Transformation>	getOperationType() Returns the operation type.

Methods inherited from class MathTransformProvider

ensureValidValues, formatWKT

Methods inherited from class DefaultOperationMethod

checkDimensions, computeHashCode, equals, getFormula, getParameters, getSourceDimensions, getTargetDimensions

Methods inherited from class AbstractIdentifiedObject

equals, getAlias, getIdentifier, getIdentifiers, getName, getName, getRemarks, hashCode, isDeprecated, nameMatches

Methods inherited from class FormattableObject

getDefaultIndentation, print, setDefaultIndentation, toString, toWKT, toWKT, toWKT, toWKT

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

DEGREE

public static final ParameterDescriptor<Integer> DEGREE

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the "degree" parameter value.

X_COEFFS

public static final ParameterDescriptor<float[]> X_COEFFS

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the "xCoeffs" parameter value.

Y_COEFFS

public static final ParameterDescriptor<float[]> Y_COEFFS

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the "yCoeffs" parameter value.

PRE_SCALE_X

public static final ParameterDescriptor<Float> PRE_SCALE_X

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the "preScaleX" parameter value.

PRE_SCALE_Y

public static final ParameterDescriptor<Float> PRE_SCALE_Y

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the "preScaleY" parameter value.

POST_SCALE_X

public static final ParameterDescriptor<Float> POST_SCALE_X

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the "postScaleX" parameter value.

POST_SCALE_Y

public static final ParameterDescriptor<Float> POST_SCALE_Y

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the "postScaleY" parameter value.

PARAMETERS

public static final ParameterDescriptorGroup PARAMETERS

The group of all parameters expected by this coordinate operation. The following table lists the operation names and the parameters recognized by Geotk:

Name:

Geotk:

WarpPolynomial

Name:

Geotk:

degree

Type:	Integer
Obligation:	mandatory
Value range:	[1…7]
Default value:	2

Name:

Geotk:

xCoeffs

Type:	float[]
Obligation:	mandatory

Name:

Geotk:

yCoeffs

Type:	float[]
Obligation:	mandatory

Name:

Geotk:

preScaleX

Type:	Float
Obligation:	optional
Value range:	(-∞ … ∞)
Default value:	1

Name:

Geotk:

preScaleY

Type:	Float
Obligation:	optional
Value range:	(-∞ … ∞)
Default value:	1

Name:

Geotk:

postScaleX

Type:	Float
Obligation:	optional
Value range:	(-∞ … ∞)
Default value:	1

Name:

Geotk:

postScaleY

Type:	Float
Obligation:	optional
Value range:	(-∞ … ∞)
Default value:	1

Constructor Detail

WarpPolynomial

public WarpPolynomial()

Creates a provider for warp transforms.

Method Detail

getOperationType

public Class<Transformation> getOperationType()

Returns the operation type.

Overrides:

getOperationType in class MathTransformProvider

Returns:

The GeoAPI interface implemented by this operation.

createMathTransform

protected MathTransform createMathTransform(ParameterValueGroup values)
                                     throws ParameterNotFoundException

Creates a warp transform from the specified group of parameter values.

Specified by:

createMathTransform in class MathTransformProvider

Parameters:

values - The group of parameter values.

Returns:

The created math transform.

Throws:

ParameterNotFoundException - if a required parameter was not found.