org.locationtech.proj4j.parser.DatumParameters Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright 2009, 2017 Martin Davis
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.locationtech.proj4j.parser;

import static org.locationtech.proj4j.util.ProjectionMath.isIdentity;

import java.util.List;

import org.locationtech.proj4j.CoordinateReferenceSystem;
import org.locationtech.proj4j.datum.Datum;
import org.locationtech.proj4j.datum.Ellipsoid;
import org.locationtech.proj4j.datum.Grid;

/**
 * Contains the parsed/computed parameter values
 * which are used to create
 * the datum and ellipsoid for a {@link CoordinateReferenceSystem}.
 * This class also implements the policies for
 * which parameters take precedence
 * when multiple inconsistent ones are present.
 *
 * @author Martin Davis
 */
public class DatumParameters {
    // TODO: check for inconsistent datum and ellipsoid (some PROJ4 cs specify both - not sure why)

    private final static double SIXTH = .1666666666666666667; /* 1/6 */
    private final static double RA4 = .04722222222222222222; /* 17/360 */
    private final static double RA6 = .02215608465608465608; /* 67/3024 */
    private final static double RV4 = .06944444444444444444; /* 5/72 */
    private final static double RV6 = .04243827160493827160; /* 55/1296 */

    private Datum datum = null;
    private double[] datumTransform = null;
    private List grids = null;

    private Ellipsoid ellipsoid;
    private double a = Double.NaN;
    private double es = Double.NaN;

    public DatumParameters() {
        // Default datum is WGS84
//    setDatum(Datum.WGS84);
    }

    public Datum getDatum() {
        if (datum != null)
            return datum;
        // if no ellipsoid was specified, return WGS84 as the default
        if (ellipsoid == null && !isDefinedExplicitly()) {
            return Datum.WGS84;
        }
        // Check for WGS84 datum parameters
        if (Ellipsoid.WGS84.equals(ellipsoid) && grids == null && (datumTransform == null || isIdentity(datumTransform)))
            return Datum.WGS84;

        // otherwise, return a custom datum with the specified ellipsoid
        return new Datum("User", datumTransform, grids, getEllipsoid(), "User-defined");
    }

    private boolean isDefinedExplicitly() {
        return !(Double.isNaN(a) || Double.isNaN(es));
    }

    public Ellipsoid getEllipsoid() {
        if (ellipsoid != null)
            return ellipsoid;
        return new Ellipsoid("user", a, es, "User-defined");
    }

    public void setDatumTransform(double[] datumTransform) {
        this.datumTransform = datumTransform;
        // force new Datum to be created
        datum = null;
    }

    public void setDatum(Datum datum) {
        this.datum = datum;
    }

    public void setEllipsoid(Ellipsoid ellipsoid) {
        this.ellipsoid = ellipsoid;
        es = ellipsoid.eccentricity2;
        a = ellipsoid.equatorRadius;
    }

    public void setGrids(List grids) {
        this.grids = grids;
    }

    public void setA(double a) {
        ellipsoid = null;  // force user-defined ellipsoid
        this.a = a;
    }

    public void setB(double b) {
        ellipsoid = null;  // force user-defined ellipsoid
        es = 1. - (b * b) / (a * a);
    }

    public void setES(double es) {
        ellipsoid = null;  // force user-defined ellipsoid
        this.es = es;
    }

    public void setRF(double rf) {
        ellipsoid = null;  // force user-defined ellipsoid
        es = rf * (2. - rf);
    }

    public void setR_A() {
        ellipsoid = null;  // force user-defined ellipsoid
        a *= 1. - es * (SIXTH + es * (RA4 + es * RA6));
    }

    public void setF(double f) {
        ellipsoid = null;  // force user-defined ellipsoid
        double rf = 1.0 / f;
        es = rf * (2. - rf);
    }

    public double getA() {
        return a;
    }

    public double getES() {
        return es;
    }
}