GeoAPI 2.0
Build 2005-06-08

org.opengis.referencing.datum
Interface Ellipsoid

All Superinterfaces:
IdentifiedObject

@UML(identifier="CD_Ellipsoid",
     specification=ISO_19111)
public interface Ellipsoid
extends IdentifiedObject

Geometric figure that can be used to describe the approximate shape of the earth. In mathematical terms, it is a surface formed by the rotation of an ellipse about its minor axis. An ellipsoid requires two defining parameters:

Since:
GeoAPI 1.0
Version:
Abstract specification 2.0

Field Summary
 
Fields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
 
Method Summary
 Unit getAxisUnit()
          Returns the linear unit of the semi-major and semi-minor axis values.
 double getInverseFlattening()
          Returns the value of the inverse of the flattening constant.
 double getSemiMajorAxis()
          Length of the semi-major axis of the ellipsoid.
 double getSemiMinorAxis()
          Length of the semi-minor axis of the ellipsoid.
 boolean isIvfDefinitive()
          Indicates if the inverse flattening is definitive for this ellipsoid.
 boolean isSphere()
          true if the ellipsoid is degenerate and is actually a sphere.
 
Methods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
 

Method Detail

getAxisUnit

@UML(identifier="getAxisUnit",
     specification=OGC_01009)
Unit getAxisUnit()
Returns the linear unit of the semi-major and semi-minor axis values.

Returns:
The axis linear unit.

getSemiMajorAxis

@UML(identifier="semiMajorAxis",
     obligation=MANDATORY,
     specification=ISO_19111)
double getSemiMajorAxis()
Length of the semi-major axis of the ellipsoid. This is the equatorial radius in axis linear unit.

Returns:
Length of semi-major axis.

getSemiMinorAxis

@UML(identifier="secondDefiningParameter.semiMinorAxis",
     obligation=CONDITIONAL,
     specification=ISO_19111)
double getSemiMinorAxis()
Length of the semi-minor axis of the ellipsoid. This is the polar radius in axis linear unit.

Returns:
Length of semi-minor axis.

getInverseFlattening

@UML(identifier="secondDefiningParameter.inverseFlattening",
     obligation=CONDITIONAL,
     specification=ISO_19111)
double getInverseFlattening()
Returns the value of the inverse of the flattening constant. The inverse flattening is related to the equatorial/polar radius by the formula ivf = re/(re-rp). For perfect spheres (i.e. if isSphere() returns true), the Double.POSITIVE_INFINITY value is used.

Returns:
The inverse flattening value.

isIvfDefinitive

@UML(identifier="CS_Ellipsoid.isIvfDefinitive",
     obligation=CONDITIONAL,
     specification=OGC_01009)
boolean isIvfDefinitive()
Indicates if the inverse flattening is 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.

Returns:
true if the inverse flattening is definitive, or false if the polar radius is definitive.

isSphere

@UML(identifier="secondDefiningParameter.isSphere",
     obligation=CONDITIONAL,
     specification=ISO_19111)
boolean isSphere()
true if the ellipsoid is degenerate and is actually a sphere. The sphere is completely defined by the semi-major axis, which is the radius of the sphere.

Returns:
true if the ellipsoid is degenerate and is actually a sphere.

GeoAPI 2.0
Build 2005-06-08

Symbols, terms and definitions
Copyright OpenGIS® Consortium