org.geotoolkit.referencing.operation.provider
Class PositionVector7Param

Object
  FormattableObject
      AbstractIdentifiedObject
          DefaultOperationMethod
              MathTransformProvider
                  PositionVector7Param

All Implemented Interfaces:

Serializable, Formattable, Deprecable, LenientComparable, IdentifiedObject, OperationMethod

Direct Known Subclasses:

CoordinateFrameRotation, GeocentricTranslation

@Immutable
public class PositionVector7Param
extends MathTransformProvider

The provider for "Position Vector 7-parameters transformation" (EPSG:9606). In addition to the EPSG parameters, this provider defines some OGC/Geotk-specific parameters. Those parameters begin with the "src_" or "tgt_" prefix, and modify the math transform as below:

• If a "src_*" parameter is present, then an EllipsoidToGeocentric transform will be concatenated before the geocentric operation.
• If a "tgt_*" parameter is present, then an GeocentricToEllipsoid transform will be concatenated after the geocentric operation.

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

Operation name: Position Vector transformation (geog2D domain)

Parameter name	Default value
dx	0 metres
dy	0 metres
dz	0 metres
ex	0 ''
ey	0 ''
ez	0 ''
ppm	0
src_semi_major
src_semi_minor
tgt_semi_major
tgt_semi_minor
src_dim	2
tgt_dim	2

Since:

2.2

Version:

3.20

Author:

Martin Desruisseaux (IRD, Geomatys)

See Also:

Geotk coordinate operations matrix, Serialized Form

Module:

referencing/geotk-referencing (download)

View source code for this class

Field Summary

static ParameterDescriptor<Double>	DX Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Double>	DY Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Double>	DZ Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Double>	EX Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Double>	EY Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Double>	EZ Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptorGroup	PARAMETERS The group of all parameters expected by this coordinate operation.
static ParameterDescriptor<Double>	PPM Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Integer>	SRC_DIM Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Double>	SRC_SEMI_MAJOR Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Double>	SRC_SEMI_MINOR Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Integer>	TGT_DIM Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Double>	TGT_SEMI_MAJOR Deprecated. Invoke PARAMETERS.descriptor(String) instead.
static ParameterDescriptor<Double>	TGT_SEMI_MINOR 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

PositionVector7Param()
Constructs the provider.

Method Summary

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

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

SRC_DIM

@Deprecated
public static final ParameterDescriptor<Integer> SRC_DIM

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the number of source geographic dimension (2 or 3). This is a Geotk-specific argument. If presents, an "Ellipsoid_To_Geocentric" transform will be concatenated before the geocentric translation.

TGT_DIM

@Deprecated
public static final ParameterDescriptor<Integer> TGT_DIM

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the number of target geographic dimension (2 or 3). This is a Geotk-specific argument. If presents, a "Geocentric_To_Ellipsoid" transform will be concatenated after the geocentric translation.

SRC_SEMI_MAJOR

@Deprecated
public static final ParameterDescriptor<Double> SRC_SEMI_MAJOR

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the "src_semi_major" optional parameter value. This is a Geotk-specific argument. If presents, an "Ellipsoid_To_Geocentric" transform will be concatenated before the geocentric translation.

Valid values range from 0 to infinity. Units are metres.

SRC_SEMI_MINOR

@Deprecated
public static final ParameterDescriptor<Double> SRC_SEMI_MINOR

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the "src_semi_minor" optional parameter value. This is a Geotk-specific argument. If presents, an "Ellipsoid_To_Geocentric" transform will be concatenated before the geocentric translation.

Valid values range from 0 to infinity. Units are metres.

TGT_SEMI_MAJOR

@Deprecated
public static final ParameterDescriptor<Double> TGT_SEMI_MAJOR

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the "tgt_semi_major" optional parameter value. This is a Geotk-specific argument. If presents, a "Geocentric_To_Ellipsoid" transform will be concatenated after the geocentric translation.

Valid values range from 0 to infinity. Units are metres.

TGT_SEMI_MINOR

@Deprecated
public static final ParameterDescriptor<Double> TGT_SEMI_MINOR

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the "tgt_semi_minor" optional parameter value. This is a Geotk-specific argument. If presents, a "Geocentric_To_Ellipsoid" transform will be concatenated after the geocentric translation.

Valid values range from 0 to infinity. Units are metres.

DX

@Deprecated
public static final ParameterDescriptor<Double> DX

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the X-axis translation (dx) parameter value. Valid values range from negative to positive infinity. Units are metres.

DY

@Deprecated
public static final ParameterDescriptor<Double> DY

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the Y-axis translation (dy) parameter value. Valid values range from negative to positive infinity. Units are metres.

DZ

@Deprecated
public static final ParameterDescriptor<Double> DZ

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the Z-axis translation (dz) parameter value. Valid values range from negative to positive infinity. Units are metres.

EX

@Deprecated
public static final ParameterDescriptor<Double> EX

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the X-axis rotation (ex) parameter value. Units are arc-seconds.

EY

@Deprecated
public static final ParameterDescriptor<Double> EY

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the Y-axis rotation (ey) parameter value. Units are arc-seconds.

EZ

@Deprecated
public static final ParameterDescriptor<Double> EZ

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the Z-axis rotation (ez) parameter value. Units are arc-seconds.

PPM

@Deprecated
public static final ParameterDescriptor<Double> PPM

Deprecated. Invoke PARAMETERS.descriptor(String) instead.

The operation parameter descriptor for the Scale difference (ppm) parameter value. Valid values range from negative to positive infinity. Units are parts per million.

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. Note that all "src_*" and "tgt_*" parameters are OGC/Geotk-specific, and modify the math transform as below:

• If a "src_*" parameter is present, then an EllipsoidToGeocentric transform will be concatenated before the geocentric translation.
• If a "tgt_*" parameter is present, then an GeocentricToEllipsoid transform will be concatenated after the geocentric translation.

Name:	EPSG:	Position Vector transformation (geog2D domain)
Alias:	EPSG:	Position Vector 7-param. transformation
	EPSG:	Bursa-Wolf
Identifier:	EPSG:	9606

Name:	OGC:	dx
Alias:	EPSG:	X-axis translation

Type:	Double
Obligation:	mandatory
Value range:	(-∞ … ∞) metres
Default value:	0 metres

Name:	OGC:	dy
Alias:	EPSG:	Y-axis translation

Type:	Double
Obligation:	mandatory
Value range:	(-∞ … ∞) metres
Default value:	0 metres

Name:	OGC:	dz
Alias:	EPSG:	Z-axis translation

Type:	Double
Obligation:	mandatory
Value range:	(-∞ … ∞) metres
Default value:	0 metres

Name:	OGC:	ex
Alias:	EPSG:	X-axis rotation

Type:	Double
Obligation:	mandatory
Value range:	[-648000 … 648000] ''
Default value:	0 ''

Name:	OGC:	ey
Alias:	EPSG:	Y-axis rotation

Type:	Double
Obligation:	mandatory
Value range:	[-648000 … 648000] ''
Default value:	0 ''

Name:	OGC:	ez
Alias:	EPSG:	Z-axis rotation

Type:	Double
Obligation:	mandatory
Value range:	[-648000 … 648000] ''
Default value:	0 ''

Name:	OGC:	ppm
Alias:	EPSG:	Scale difference

Type:	Double
Obligation:	mandatory
Value range:	(-∞ … ∞)
Default value:	0

Name:

OGC:

src_semi_major

Type:	Double
Obligation:	optional
Value range:	[0…∞) metres

Name:

OGC:

src_semi_minor

Type:	Double
Obligation:	optional
Value range:	[0…∞) metres

Name:

OGC:

tgt_semi_major

Type:	Double
Obligation:	optional
Value range:	[0…∞) metres

Name:

OGC:

tgt_semi_minor

Type:	Double
Obligation:	optional
Value range:	[0…∞) metres

Name:

Geotk:

src_dim

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

Name:

Geotk:

tgt_dim

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

Constructor Detail

PositionVector7Param

public PositionVector7Param()

Constructs the provider.

Method Detail

getOperationType

public Class<Transformation> getOperationType()

Returns the operation type, which is a transformation.

Overrides:

getOperationType in class MathTransformProvider

Returns:

The GeoAPI interface implemented by this operation.

createMathTransform

protected MathTransform createMathTransform(ParameterValueGroup values)
                                     throws ParameterNotFoundException

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.