org.geotools.cs
Class Ellipsoid

java.lang.Object
  org.geotools.cs.Info
      org.geotools.cs.Ellipsoid

All Implemented Interfaces:

org.opengis.referencing.IdentifiedObject, java.io.Serializable

Deprecated. Replaced by DefaultEllipsoid.

public class Ellipsoid

extends Info

The figure formed by the rotation of an ellipse about an axis. In this context, the axis of rotation is always the minor axis. It is named geodetic ellipsoid if the parameters are derived by the measurement of the shape and the size of the Earth to approximate the geoid as close as possible.

Version:

$Id: Ellipsoid.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

OpenGIS (www.opengis.org), Martin Desruisseaux

See Also:

CS_Ellipsoid, Serialized Form

Field Summary

static Ellipsoid

WGS84 Deprecated. WGS 1984 ellipsoid.

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

protected

Ellipsoid(java.lang.CharSequence name, double semiMajorAxis, double semiMinorAxis, double inverseFlattening, boolean ivfDefinitive, Unit unit) Deprecated. Constructs a new ellipsoid using the specified axis length.

Method Summary

static Ellipsoid	createEllipsoid(java.lang.CharSequence name, double semiMajorAxis, double semiMinorAxis, Unit unit) Deprecated. Replaced by DefaultEllipsoid.createEllipsoid(java.lang.String, double, double, javax.units.Unit).
static Ellipsoid	createFlattenedSphere(java.lang.CharSequence name, double semiMajorAxis, double inverseFlattening, Unit unit) Deprecated. Replaced by DefaultEllipsoid.createFlattenedSphere(java.lang.String, double, double, javax.units.Unit).
boolean	equals(Info object, boolean compareNames) Deprecated. Compare this ellipsoid with the specified object for equality.
Unit	getAxisUnit() Deprecated. Replaced by DefaultEllipsoid.getAxisUnit().
double	getEccentricity() Deprecated. Replaced by DefaultEllipsoid.getEccentricity().
double	getInverseFlattening() Deprecated. Replaced by DefaultEllipsoid.getInverseFlattening().
double	getSemiMajorAxis() Deprecated. Replaced by DefaultEllipsoid.getSemiMajorAxis().
double	getSemiMinorAxis() Deprecated. Replaced by DefaultEllipsoid.getSemiMinorAxis().
int	hashCode() Deprecated. Returns a hash value for this ellipsoid.
boolean	isIvfDefinitive() Deprecated. Replaced by DefaultEllipsoid.isIvfDefinitive().
double	orthodromicDistance(double x1, double y1, double x2, double y2) Deprecated. Replaced by DefaultEllipsoid.orthodromicDistance(double,double,double,double).
double	orthodromicDistance(java.awt.geom.Point2D P1, java.awt.geom.Point2D P2) Deprecated. Replaced by DefaultEllipsoid.orthodromicDistance(Point2D,Point2D).

Methods inherited from class org.geotools.cs.Info

ensureNonNull, equals, getAbbreviation, getAlias, getAlias, getAuthority, getAuthorityCode, getIdentifiers, getName, getRemarks, toString, toWKT

Methods inherited from class java.lang.Object

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

Field Detail

WGS84

public static final Ellipsoid WGS84

Deprecated.

WGS 1984 ellipsoid. This ellipsoid is used in GPS systems and is the default for most org.geotools packages.

Constructor Detail

Ellipsoid

protected Ellipsoid(java.lang.CharSequence name,
                    double semiMajorAxis,
                    double semiMinorAxis,
                    double inverseFlattening,
                    boolean ivfDefinitive,
                    Unit unit)

Deprecated.

Constructs a new ellipsoid using the specified axis length.

Parameters:

name - Name of this ellipsoid.

semiMajorAxis - The equatorial radius.

semiMinorAxis - The polar radius.

inverseFlattening - The inverse of the flattening value.

ivfDefinitive - true if the inverse flattening is definitive.

unit - The units of the semi-major and semi-minor axis values.

Method Detail

createEllipsoid

public static Ellipsoid createEllipsoid(java.lang.CharSequence name,
                                        double semiMajorAxis,
                                        double semiMinorAxis,
                                        Unit unit)

Deprecated. Replaced by DefaultEllipsoid.createEllipsoid(java.lang.String, double, double, javax.units.Unit).

Constructs a new ellipsoid using the specified axis length.

Parameters:

name - Name of this ellipsoid.

semiMajorAxis - The equatorial radius.

semiMinorAxis - The polar radius.

unit - The units of the semi-major and semi-minor axis values.

See Also:

CoordinateSystemFactory.createEllipsoid(java.lang.CharSequence, double, double, org.geotools.units.Unit)

createFlattenedSphere

public static Ellipsoid createFlattenedSphere(java.lang.CharSequence name,
                                              double semiMajorAxis,
                                              double inverseFlattening,
                                              Unit unit)

Deprecated. Replaced by DefaultEllipsoid.createFlattenedSphere(java.lang.String, double, double, javax.units.Unit).

Constructs a new ellipsoid using the specified axis length and inverse flattening value.

Parameters:

name - Name of this ellipsoid.

semiMajorAxis - The equatorial radius.

inverseFlattening - The inverse flattening value.

unit - The units of the semi-major and semi-minor axis values.

See Also:

CoordinateSystemFactory.createFlattenedSphere(java.lang.CharSequence, double, double, org.geotools.units.Unit)

getSemiMajorAxis

public double getSemiMajorAxis()

Deprecated. Replaced by DefaultEllipsoid.getSemiMajorAxis().

Gets the equatorial radius. The returned length is expressed in this object's axis units.

See Also:

CS_Ellipsoid.getSemiMajorAxis()

getSemiMinorAxis

public double getSemiMinorAxis()

Deprecated. Replaced by DefaultEllipsoid.getSemiMinorAxis().

Gets the polar radius. The returned length is expressed in this object's axis units.

See Also:

CS_Ellipsoid.getSemiMinorAxis()

getEccentricity

public double getEccentricity()

Deprecated. Replaced by DefaultEllipsoid.getEccentricity().

The ratio of the distance between the center and a focus of the ellipse to the length of its semimajor axis. The eccentricity can alternately be computed from the equation: e=sqrt(2f-f?).

getInverseFlattening

public double getInverseFlattening()

Deprecated. Replaced by DefaultEllipsoid.getInverseFlattening().

Returns the value of the inverse of the flattening constant. Flattening is a value used to indicate how closely an ellipsoid approaches a spherical shape. The inverse flattening is related to the equatorial/polar radius (r_e and r_p respectively) by the formula ivf=re/(re-rp). For perfect spheres, this method returns Double.POSITIVE_INFINITY (which is the correct value).

See Also:

CS_Ellipsoid.getInverseFlattening()

isIvfDefinitive

public boolean isIvfDefinitive()

Deprecated. Replaced by DefaultEllipsoid.isIvfDefinitive().

Tells if the Inverse Flattening definitive for this ellipsoid. Some ellipsoids use the IVF as the defining value, and calculate the polar radius whenever asked. Other ellipsoids use the polar radius to calculate the IVF whenever asked. This distinction can be important to avoid floating-point rounding errors.

See Also:

CS_Ellipsoid.isIvfDefinitive()

orthodromicDistance

public double orthodromicDistance(java.awt.geom.Point2D P1,
                                  java.awt.geom.Point2D P2)

Deprecated. Replaced by DefaultEllipsoid.orthodromicDistance(Point2D,Point2D).

Returns the orthodromic distance between two geographic coordinates. The orthodromic distance is the shortest distance between two points on a sphere's surface. The default implementation delegates the work to orthodromicDistance(double,double,double,double).

Parameters:

P1 - Longitude and latitude of first point (in degrees).

P2 - Longitude and latitude of second point (in degrees).

Returns:

The orthodromic distance (in the units of this ellipsoid).

orthodromicDistance

public double orthodromicDistance(double x1,
                                  double y1,
                                  double x2,
                                  double y2)

Deprecated. Replaced by DefaultEllipsoid.orthodromicDistance(double,double,double,double).

Returns the orthodromic distance between two geographic coordinates. The orthodromic distance is the shortest distance between two points on a sphere's surface. The orthodromic path is always on a great circle. This is different from the loxodromic distance, which is a longer distance on a path with a constant direction on the compass.

Parameters:

x1 - Longitude of first point (in degrees).

y1 - Latitude of first point (in degrees).

x2 - Longitude of second point (in degrees).

y2 - Latitude of second point (in degrees).

Returns:

The orthodromic distance (in the units of this ellipsoid's axis).

getAxisUnit

public Unit getAxisUnit()

Deprecated. Replaced by DefaultEllipsoid.getAxisUnit().

Returns the units of the semi-major and semi-minor axis values.

See Also:

CS_Ellipsoid.getAxisUnit()

equals

public boolean equals(Info object,
                      boolean compareNames)

Deprecated.

Compare this ellipsoid with the specified object for equality.

Overrides:

equals in class Info

Parameters:

object - The object to compare to this.

compareNames - true to comparare the name, alias, authority code, etc. as well, or false to compare only properties relevant to transformations.

Returns:

true if both objects are equal.

hashCode

public int hashCode()

Deprecated.

Returns a hash value for this ellipsoid. Name, alias, authority code and the like are not taken in account. In other words, two ellipsoids will return the same hash value if they are equal in the sense of equals(Info, false).

Overrides:

hashCode in class Info

Returns:

The hash code value. This value doesn't need to be the same in past or future versions of this class.