org.geotoolkit.referencing.operation.provider
Class EllipsoidToGeoid

Object
  FormattableObject
      AbstractIdentifiedObject
          DefaultOperationMethod
              MathTransformProvider
                  EllipsoidToGeoid

All Implemented Interfaces:

Serializable, Formattable, Deprecable, LenientComparable, IdentifiedObject, OperationMethod

@Immutable
public class EllipsoidToGeoid
extends MathTransformProvider

The provider for "Ellipsoid to Geoid" vertical transformation. This transformation uses a Earth Gravitational Model.

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

Operation name: Ellipsoid_To_Geoid

Parameter name	Default value
Datum	"WGS84"
Order	180

Since:

2.3

Version:

3.20

Author:

Martin Desruisseaux (IRD, Geomatys)

See Also:

Geotk coordinate operations matrix, Serialized Form

Module:

referencing/geotk-referencing3D (download)

View source code for this class

Field Summary

static ParameterDescriptor<String>	DATUM Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Integer>	ORDER Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptorGroup	PARAMETERS The group of all parameters expected by this coordinate operation.

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

EllipsoidToGeoid()
Constructs a provider.

Method Summary

protected MathTransform	createMathTransform(ParameterValueGroup values) Creates a math transform from the specified group of parameter values.
Class<? extends 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

DATUM

public static final ParameterDescriptor<String> DATUM

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the datum. Valid values are "WGS84" and "WGS72".

ORDER

public static final ParameterDescriptor<Integer> ORDER

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the maximum degree and order. The default value is 180.

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:

Ellipsoid_To_Geoid

Name:

Geotk:

Datum

Type:	String
Obligation:	mandatory
Default value:	"WGS84"

Name:

Geotk:

Order

Type:	Integer
Obligation:	optional
Value range:	[2 … 180]
Default value:	180

Constructor Detail

EllipsoidToGeoid

public EllipsoidToGeoid()

Constructs a provider.

Method Detail

getOperationType

public Class<? extends 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,
                                            FactoryException

Creates a math 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.

FactoryException - if this method failed to load the coefficient file.