org.geotoolkit.referencing.cs
Class DefaultEllipsoidalCS

Object
  FormattableObject
      AbstractIdentifiedObject
          AbstractCS
              DefaultEllipsoidalCS

All Implemented Interfaces:

Serializable, Formattable, LenientComparable, CoordinateSystem, EllipsoidalCS, IdentifiedObject

@Immutable
public class DefaultEllipsoidalCS
extends AbstractCS
implements EllipsoidalCS

A two- or three-dimensional coordinate system in which position is specified by geodetic latitude, geodetic longitude, and (in the three-dimensional case) ellipsoidal height. An EllipsoidalCS shall have two or three axis.

Used with CRS type(s)

Geographic, Engineering

Since:

2.0

Version:

3.18

Author:

Martin Desruisseaux (IRD, Geomatys)

See Also:

Serialized Form

Module:

referencing/geotk-referencing (download)

View source code for this class

Field Summary

static DefaultEllipsoidalCS	GEODETIC_2D A two-dimensional ellipsoidal CS with geodetic longitude, geodetic latitude axis in decimal degrees.
static DefaultEllipsoidalCS	GEODETIC_3D A three-dimensional ellipsoidal CS with geodetic longitude, geodetic latitude, ellipsoidal height axis.

Fields inherited from class AbstractIdentifiedObject

EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR

Fields inherited from class FormattableObject

EPSG, GEOTIFF, INTERNAL, OGC, SINGLE_LINE

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

DefaultEllipsoidalCS(EllipsoidalCS cs)
Constructs a new coordinate system with the same values than the specified one.

DefaultEllipsoidalCS(Map<String,?> properties, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1)
Constructs a two-dimensional coordinate system from a set of properties.

DefaultEllipsoidalCS(Map<String,?> properties, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1, CoordinateSystemAxis axis2)
Constructs a three-dimensional coordinate system from a set of properties.

DefaultEllipsoidalCS(String name, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1)
Constructs a two-dimensional coordinate system from a name.

DefaultEllipsoidalCS(String name, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1, CoordinateSystemAxis axis2)
Constructs a three-dimensional coordinate system from a name.

Method Summary

double	getHeight(double[] coordinates) Returns the height found in the specified coordinate point, always in metres.
double	getLatitude(double[] coordinates) Returns the latitude found in the specified coordinate point, always in decimal degrees.
double	getLongitude(double[] coordinates) Returns the longitude found in the specified coordinate point, always in decimal degrees.
protected boolean	isCompatibleDirection(AxisDirection direction) Returns true if the specified axis direction is allowed for this coordinate system.
protected boolean	isCompatibleUnit(AxisDirection direction, Unit<?> unit) Returns true if the specified unit is an angular units, or a linear one in the special case of height.
DefaultEllipsoidalCS	usingUnit(Unit<?> unit) Returns a new coordinate system with the same properties than the current one except for axis units.
static DefaultEllipsoidalCS	wrap(EllipsoidalCS object) Returns a Geotk coordinate system implementation with the same values than the given arbitrary implementation.

Methods inherited from class AbstractCS

computeHashCode, distance, equals, formatWKT, getAxis, getDimension, standard, swapAndScaleAxis

Methods inherited from class AbstractIdentifiedObject

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

Methods inherited from class FormattableObject

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

Methods inherited from class Object

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

Methods inherited from interface CoordinateSystem

getAxis, getDimension

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

GEODETIC_2D

public static final DefaultEllipsoidalCS GEODETIC_2D

A two-dimensional ellipsoidal CS with geodetic longitude, geodetic latitude axis in decimal degrees.

GEODETIC_3D

public static final DefaultEllipsoidalCS GEODETIC_3D

A three-dimensional ellipsoidal CS with geodetic longitude, geodetic latitude, ellipsoidal height axis.

Constructor Detail

DefaultEllipsoidalCS

public DefaultEllipsoidalCS(EllipsoidalCS cs)

Constructs a new coordinate system with the same values than the specified one. This copy constructor provides a way to wrap an arbitrary implementation into a Geotk one or a user-defined one (as a subclass), usually in order to leverage some implementation-specific API. This constructor performs a shallow copy, i.e. the properties are not cloned.

Parameters:

cs - The coordinate system to copy.

Since:

2.2

DefaultEllipsoidalCS

public DefaultEllipsoidalCS(String name,
                            CoordinateSystemAxis axis0,
                            CoordinateSystemAxis axis1)

Constructs a two-dimensional coordinate system from a name.

Parameters:

name - The coordinate system name.

axis0 - The first axis.

axis1 - The second axis.

DefaultEllipsoidalCS

public DefaultEllipsoidalCS(String name,
                            CoordinateSystemAxis axis0,
                            CoordinateSystemAxis axis1,
                            CoordinateSystemAxis axis2)

Constructs a three-dimensional coordinate system from a name.

Parameters:

name - The coordinate system name.

axis0 - The first axis.

axis1 - The second axis.

axis2 - The third axis.

DefaultEllipsoidalCS

public DefaultEllipsoidalCS(Map<String,?> properties,
                            CoordinateSystemAxis axis0,
                            CoordinateSystemAxis axis1)

Constructs a two-dimensional coordinate system from a set of properties. The properties map is given unchanged to the super-class constructor.

Parameters:

properties - Set of properties. Should contains at least "name".

axis0 - The first axis.

axis1 - The second axis.

DefaultEllipsoidalCS

public DefaultEllipsoidalCS(Map<String,?> properties,
                            CoordinateSystemAxis axis0,
                            CoordinateSystemAxis axis1,
                            CoordinateSystemAxis axis2)

Constructs a three-dimensional coordinate system from a set of properties. The properties map is given unchanged to the super-class constructor.

Parameters:

properties - Set of properties. Should contains at least "name".

axis0 - The first axis.

axis1 - The second axis.

axis2 - The third axis.

Method Detail

wrap

public static DefaultEllipsoidalCS wrap(EllipsoidalCS object)

Returns a Geotk coordinate system implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object.

Parameters:

object - The object to wrap in a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

isCompatibleDirection

protected boolean isCompatibleDirection(AxisDirection direction)

Returns true if the specified axis direction is allowed for this coordinate system. The default implementation accepts only the following directions: NORTH, SOUTH, EAST, WEST, UP and DOWN.

Overrides:

isCompatibleDirection in class AbstractCS

Parameters:

direction - The direction to test for compatibility.

Returns:

true if the given direction is compatible with this coordinate system.

isCompatibleUnit

protected boolean isCompatibleUnit(AxisDirection direction,
                                   Unit<?> unit)

Returns true if the specified unit is an angular units, or a linear one in the special case of height. This method is invoked at construction time for checking units compatibility.

Overrides:

isCompatibleUnit in class AbstractCS

Parameters:

direction - The direction of the axis having the given unit.

unit - The unit to test for compatibility.

Returns:

true if the given unit is compatible with this coordinate system.

Since:

2.2

getLongitude

public double getLongitude(double[] coordinates)
                    throws MismatchedDimensionException

Returns the longitude found in the specified coordinate point, always in decimal degrees.

Parameters:

coordinates - The coordinate point expressed in this coordinate system.

Returns:

The longitude in the specified array, in decimal degrees.

Throws:

MismatchedDimensionException - is the coordinate point doesn't have the expected dimension.

getLatitude

public double getLatitude(double[] coordinates)
                   throws MismatchedDimensionException

Returns the latitude found in the specified coordinate point, always in decimal degrees.

Parameters:

coordinates - The coordinate point expressed in this coordinate system.

Returns:

The latitude in the specified array, in decimal degrees.

Throws:

MismatchedDimensionException - is the coordinate point doesn't have the expected dimension.

getHeight

public double getHeight(double[] coordinates)
                 throws MismatchedDimensionException

Returns the height found in the specified coordinate point, always in metres.

Parameters:

coordinates - The coordinate point expressed in this coordinate system.

Returns:

The height in the specified array, in metres.

Throws:

MismatchedDimensionException - is the coordinate point doesn't have the expected dimension.

usingUnit

public DefaultEllipsoidalCS usingUnit(Unit<?> unit)
                               throws IllegalArgumentException

Returns a new coordinate system with the same properties than the current one except for axis units.

Parameters:

unit - The unit for the new axis.

Returns:

A coordinate system with axis using the specified units.

Throws:

IllegalArgumentException - If the specified unit is incompatible with the expected one.

Since:

2.2

TODO:

Current implementation can't work for 3D coordinate systems.