org.geotoolkit.referencing.datum.DefaultGeodeticDatum Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of geotk-referencing Show documentation
Show all versions of geotk-referencing Show documentation
Implementations of Coordinate Reference Systems (CRS),
conversion and transformation services derived from ISO 19111.
/*
* Geotoolkit.org - An Open Source Java GIS Toolkit
* http://www.geotoolkit.org
*
* (C) 2001-2011, Open Source Geospatial Foundation (OSGeo)
* (C) 2009-2011, Geomatys
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* This package contains documentation from OpenGIS specifications.
* OpenGIS consortium's work is fully acknowledged here.
*/
package org.geotoolkit.referencing.datum;
import java.util.Map;
import java.util.Set;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Collections;
import java.util.LinkedHashSet;
import net.jcip.annotations.Immutable;
import org.opengis.referencing.ReferenceIdentifier;
import org.opengis.referencing.datum.Datum;
import org.opengis.referencing.datum.Ellipsoid;
import org.opengis.referencing.datum.PrimeMeridian;
import org.opengis.referencing.datum.GeodeticDatum;
import org.opengis.referencing.operation.Matrix;
import org.geotoolkit.metadata.iso.citation.Citations;
import org.geotoolkit.referencing.IdentifiedObjects;
import org.geotoolkit.referencing.operation.matrix.XMatrix;
import org.geotoolkit.referencing.AbstractIdentifiedObject;
import org.geotoolkit.referencing.NamedIdentifier;
import org.geotoolkit.util.ComparisonMode;
import org.geotoolkit.util.Utilities;
import org.geotoolkit.io.wkt.Formatter;
import static org.geotoolkit.util.Utilities.hash;
import static org.geotoolkit.util.Utilities.deepEquals;
import static org.geotoolkit.util.ArgumentChecks.ensureNonNull;
/**
* Defines the location and precise orientation in 3-dimensional space of a defined ellipsoid
* (or sphere) that approximates the shape of the earth. Used also for Cartesian coordinate
* system centered in this ellipsoid (or sphere).
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @version 3.19
*
* @see Ellipsoid
* @see PrimeMeridian
*
* @since 1.2
* @module
*/
@Immutable
public class DefaultGeodeticDatum extends AbstractDatum implements GeodeticDatum {
/**
* Serial number for inter-operability with different versions.
*/
private static final long serialVersionUID = 8832100095648302943L;
/**
* The array to be returned when there is no Bursa Wolf parameters.
*/
private static final BursaWolfParameters[] EMPTY_BURSAWOLF = new BursaWolfParameters[0];
/**
* Default WGS 1984 datum (EPSG:6326).
* Prime meridian is {@linkplain DefaultPrimeMeridian#GREENWICH Greenwich}.
* This datum is used in GPS systems and is the default for most {@code org.geotoolkit} packages.
*
* @see DefaultEllipsoid#WGS84
* @see org.geotoolkit.referencing.crs.DefaultGeographicCRS#WGS84
*/
public static final DefaultGeodeticDatum WGS84;
static {
final ReferenceIdentifier[] identifiers = {
new NamedIdentifier(Citations.OGC, "WGS84"),
new NamedIdentifier(Citations.ORACLE, "WGS 84"),
new NamedIdentifier(null, "WGS_84"),
new NamedIdentifier(null, "WGS 1984"),
new NamedIdentifier(null, "WGS_1984"),
new NamedIdentifier(Citations.ESRI, "D_WGS_1984"),
new NamedIdentifier(Citations.EPSG, "World Geodetic System 1984")
};
final Map properties = new HashMap(6);
properties.put(NAME_KEY, identifiers[0]);
properties.put(ALIAS_KEY, identifiers);
properties.put(IDENTIFIERS_KEY, new NamedIdentifier(Citations.EPSG, "6326"));
WGS84 = new DefaultGeodeticDatum(properties, DefaultEllipsoid.WGS84);
}
/**
* Default WGS 1972 datum (EPSG:6322).
* Prime meridian is {@linkplain DefaultPrimeMeridian#GREENWICH Greenwich}.
* This datum is used, together with {@linkplain #WGS84}, in
* {@linkplain org.geotoolkit.referencing.operation.transform.EarthGravitationalModel
* Earth Gravitational Model}.
*
* @see DefaultEllipsoid#WGS72
*
* @since 3.00
*/
public static final DefaultGeodeticDatum WGS72;
static {
final ReferenceIdentifier[] identifiers = {
new NamedIdentifier(Citations.OGC, "WGS72"),
new NamedIdentifier(Citations.EPSG, "World Geodetic System 1972")
};
final Map properties = new HashMap(6);
properties.put(NAME_KEY, identifiers[0]);
properties.put(ALIAS_KEY, identifiers);
properties.put(IDENTIFIERS_KEY, new NamedIdentifier(Citations.EPSG, "6322"));
WGS72 = new DefaultGeodeticDatum(properties, DefaultEllipsoid.WGS72);
}
/**
* Default spherical datum.
* Prime meridian is {@linkplain DefaultPrimeMeridian#GREENWICH Greenwich}.
*
* {@note This datum is close, but not identical, to the datum based on GRS 1980
* Authalic Sphere (EPSG:6047). This datum uses a sphere radius of 6371000
* metres, while the GRS 1980 Authalic Sphere uses a sphere radius of 6371007 metres.}
*
* @see DefaultEllipsoid#SPHERE
* @see org.geotoolkit.referencing.crs.DefaultGeographicCRS#SPHERE
*
* @since 3.15
*/
public static final DefaultGeodeticDatum SPHERE = new DefaultGeodeticDatum(
IdentifiedObjects.getProperties(DefaultEllipsoid.SPHERE), DefaultEllipsoid.SPHERE);
/**
* The {@value #BURSA_WOLF_KEY} property for
* {@linkplain #getAffineTransform datum shifts}.
*/
public static final String BURSA_WOLF_KEY = "bursaWolf";
/**
* The ellipsoid.
*/
private final Ellipsoid ellipsoid;
/**
* The prime meridian.
*/
private final PrimeMeridian primeMeridian;
/**
* Bursa Wolf parameters for datum shifts, or {@code null} if none.
*/
private final BursaWolfParameters[] bursaWolf;
/**
* Constructs a new object in which every attributes are set to a default value.
* This is not a valid object. This constructor is strictly
* reserved to JAXB, which will assign values to the fields using reflexion.
*/
private DefaultGeodeticDatum() {
this(org.geotoolkit.internal.referencing.NilReferencingObject.INSTANCE);
}
/**
* Constructs a new datum with the same values than the specified one.
* This copy constructor provides a way to convert 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.
*
* @param datum The datum to copy.
*
* @since 2.2
*/
public DefaultGeodeticDatum(final GeodeticDatum datum) {
super(datum);
ellipsoid = datum.getEllipsoid();
primeMeridian = datum.getPrimeMeridian();
bursaWolf = (datum instanceof DefaultGeodeticDatum) ?
((DefaultGeodeticDatum) datum).bursaWolf : null;
}
/**
* Constructs a geodetic datum using the {@linkplain DefaultPrimeMeridian#GREENWICH Greenwich}
* prime meridian. This is a convenience constructor for the very common case where the prime
* meridian is the Greenwich one.
*
* @param name The datum name.
* @param ellipsoid The ellipsoid.
*
* @since 3.15
*/
public DefaultGeodeticDatum(final String name, final Ellipsoid ellipsoid) {
this(name, ellipsoid, DefaultPrimeMeridian.GREENWICH);
}
/**
* Constructs a geodetic datum using the {@linkplain DefaultPrimeMeridian#GREENWICH Greenwich}
* prime meridian. This is a convenience constructor for the very common case where the prime
* meridian is the Greenwich one.
*
* @param properties Set of properties. Should contains at least {@code "name"}.
* @param ellipsoid The ellipsoid.
*
* @since 3.15
*/
public DefaultGeodeticDatum(final Map properties, final Ellipsoid ellipsoid) {
this(properties, ellipsoid, DefaultPrimeMeridian.GREENWICH);
}
/**
* Constructs a geodetic datum from a name and the given prime meridian.
*
* @param name The datum name.
* @param ellipsoid The ellipsoid.
* @param primeMeridian The prime meridian. If omitted, the default is
* {@linkplain DefaultPrimeMeridian#GREENWICH Greenwich}.
*/
public DefaultGeodeticDatum(final String name,
final Ellipsoid ellipsoid,
final PrimeMeridian primeMeridian)
{
this(Collections.singletonMap(NAME_KEY, name), ellipsoid, primeMeridian);
}
/**
* Constructs a geodetic datum from a set of properties. The properties map is given
* unchanged to the {@linkplain AbstractDatum#AbstractDatum(Map) super-class constructor}.
* Additionally, the following properties are understood by this constructor:
*
*
*
* Property name
* Value type
* Value given to
*
*
* {@value #BURSA_WOLF_KEY}
* {@link BursaWolfParameters} or an array of those
* {@link #getBursaWolfParameters}
*
*
*
* @param properties Set of properties. Should contains at least {@code "name"}.
* @param ellipsoid The ellipsoid.
* @param primeMeridian The prime meridian. If omitted, the default is
* {@linkplain DefaultPrimeMeridian#GREENWICH Greenwich}.
*/
public DefaultGeodeticDatum(final Map properties,
final Ellipsoid ellipsoid,
final PrimeMeridian primeMeridian)
{
super(properties);
this.ellipsoid = ellipsoid;
this.primeMeridian = primeMeridian;
ensureNonNull("ellipsoid", ellipsoid);
ensureNonNull("primeMeridian", primeMeridian);
BursaWolfParameters[] bursaWolf;
final Object object = properties.get(BURSA_WOLF_KEY);
if (object instanceof BursaWolfParameters) {
bursaWolf = new BursaWolfParameters[] {
((BursaWolfParameters) object).clone()
};
} else {
bursaWolf = (BursaWolfParameters[]) object;
if (bursaWolf != null) {
if (bursaWolf.length == 0) {
bursaWolf = null;
} else {
final Set s = new LinkedHashSet();
for (int i=0; i exclusion)
{
ensureNonNull("source", source);
ensureNonNull("target", target);
if (source instanceof DefaultGeodeticDatum) {
final BursaWolfParameters[] bursaWolf = ((DefaultGeodeticDatum) source).bursaWolf;
if (bursaWolf != null) {
for (int i=0; i();
}
if (exclusion.add(source)) {
if (exclusion.add(target)) {
step1 = getAffineTransform(source, sourceStep, exclusion);
if (step1 != null) {
step2 = getAffineTransform(targetStep, target, exclusion);
if (step2 != null) {
/*
* Note: XMatrix.multiply(XMatrix) is equivalent to
* AffineTransform.concatenate(...): First
* transform by the supplied transform and
* then transform the result by the original
* transform.
*/
step2.multiply(step1);
return step2;
}
}
exclusion.remove(target);
}
exclusion.remove(source);
}
}
}
}
}
}
return null;
}
/**
* Returns {@code true} if the specified object is equals (at least on computation purpose)
* to the {@link #WGS84} datum. This method may conservatively returns {@code false} if the
* specified datum is uncertain (for example because it come from an other implementation).
*
* @param datum The datum to inspect.
* @return {@code true} if the given datum is equal to WGS84 for computational purpose.
*/
public static boolean isWGS84(final Datum datum) {
if (datum instanceof AbstractIdentifiedObject) {
return WGS84.equals((AbstractIdentifiedObject) datum, ComparisonMode.IGNORE_METADATA);
}
// Maybe the specified object has its own test...
return datum!=null && datum.equals(WGS84);
}
/**
* Compare this datum with the specified object for equality.
*
* @param object The object to compare to {@code this}.
* @param mode {@link ComparisonMode#STRICT STRICT} for performing a strict comparison, or
* {@link ComparisonMode#IGNORE_METADATA IGNORE_METADATA} for comparing only properties
* relevant to transformations.
* @return {@code true} if both objects are equal.
*/
@Override
public boolean equals(final Object object, final ComparisonMode mode) {
if (object == this) {
return true; // Slight optimization.
}
if (super.equals(object, mode)) {
switch (mode) {
case STRICT: {
final DefaultGeodeticDatum that = (DefaultGeodeticDatum) object;
return Utilities.equals(this.ellipsoid, that.ellipsoid) &&
Utilities.equals(this.primeMeridian, that.primeMeridian) &&
Arrays.equals(this.bursaWolf, that.bursaWolf);
}
default: {
final GeodeticDatum that = (GeodeticDatum) object;
return deepEquals(getEllipsoid(), that.getEllipsoid(), mode) &&
deepEquals(getPrimeMeridian(), that.getPrimeMeridian(), mode);
/*
* HACK: We do not consider Bursa Wolf parameters as a non-metadata field.
* This is needed in order to get equalsIgnoreMetadata(...) to returns
* 'true' when comparing the WGS84 constant in this class with a WKT
* DATUM element with a TOWGS84[0,0,0,0,0,0,0] element. Furthermore,
* the Bursa Wolf parameters are not part of ISO 19111 specification.
* We don't want two CRS to be considered as different because one has
* more of those transformation informations (which is nice, but doesn't
* change the CRS itself).
*/
}
}
}
return false;
}
/**
* {@inheritDoc}
*/
@Override
protected int computeHashCode() {
return hash(ellipsoid, hash(primeMeridian, super.computeHashCode()));
}
/**
* Formats the inner part of a
* Well
* Known Text (WKT) element.
*
* @param formatter The formatter to use.
* @return The WKT element name, which is {@code "DATUM"}.
*/
@Override
public String formatWKT(final Formatter formatter) {
// Do NOT invokes the super-class method, because
// horizontal datum do not write the datum type.
formatter.append(ellipsoid);
if (bursaWolf != null) {
for (int i=0; i