/src/proj/src/ell_set.cpp

Source
/* set ellipsoid parameters a and es */

#include <math.h>
#include <stddef.h>
#include <string.h>

#include "proj.h"
#include "proj_internal.h"

/* Prototypes of the pj_ellipsoid helper functions */
static int ellps_ellps(PJ *P);
static int ellps_size(PJ *P);
static int ellps_shape(PJ *P);
static int ellps_spherification(PJ *P);

static paralist *pj_get_param(paralist *list, const char *key);
static char *pj_param_value(paralist *list);
static const PJ_ELLPS *pj_find_ellps(const char *name);

/***************************************************************************************/
int pj_ellipsoid(PJ *P) {
    /****************************************************************************************
        This is a replacement for the classic PROJ pj_ell_set function. The main
    difference is that pj_ellipsoid augments the PJ object with a copy of the
    exact tags used to define its related ellipsoid.

        This makes it possible to let a new PJ object inherit the geometrical
    properties of an existing one.

        A complete ellipsoid definition comprises a size (primary) and a shape
    (secondary) parameter.

        Size parameters supported are:
            R, defining the radius of a spherical planet
            a, defining the semimajor axis of an ellipsoidal planet

        Shape parameters supported are:
            rf, the reverse flattening of the ellipsoid
            f,  the flattening of the ellipsoid
            es, the eccentricity squared
            e,  the eccentricity
            b,  the semiminor axis

        The ellps=xxx parameter provides both size and shape for a number of
    built in ellipsoid definitions.

        The ellipsoid definition may be augmented with a spherification flag,
    turning the ellipsoid into a sphere with features defined by the ellipsoid.

        Spherification parameters supported are:
            R_A, which gives a sphere with the same surface area as the
            ellipsoid R_V, which gives a sphere with the same volume as the
    ellipsoid

            R_a, which gives a sphere with R = (a + b)/2   (arithmetic mean)
            R_g, which gives a sphere with R = sqrt(a*b)   (geometric mean)
            R_h, which gives a sphere with R = 2*a*b/(a+b) (harmonic mean)

            R_lat_a=phi, which gives a sphere with R being the arithmetic mean
            of of the corresponding ellipsoid at latitude phi.
            R_lat_g=phi, which gives
            a sphere with R being the geometric mean of of the corresponding
    ellipsoid at latitude phi.

            R_C, which gives a sphere with the radius of the conformal sphere
            at phi0.

        If R is given as size parameter, any shape and spherification parameters
        given are ignored.

        If size and shape are given as ellps=xxx, later shape and size
    parameters are are taken into account as modifiers for the built in
    ellipsoid definition.

        While this may seem strange, it is in accordance with historical PROJ
        behavior. It can e.g. be used to define coordinates on the ellipsoid
        scaled to unit semimajor axis by specifying "+ellps=xxx +a=1"

    ****************************************************************************************/
    int err = proj_errno_reset(P);
    const char *empty = {""};

    free(P->def_size);
    P->def_size = nullptr;
    free(P->def_shape);
    P->def_shape = nullptr;
    free(P->def_spherification);
    P->def_spherification = nullptr;
    free(P->def_ellps);
    P->def_ellps = nullptr;

    /* Specifying R overrules everything */
    if (pj_get_param(P->params, "R")) {
        if (0 != ellps_size(P))
            return 1;
        pj_calc_ellipsoid_params(P, P->a, 0);
        if (proj_errno(P))
            return 1;
        return proj_errno_restore(P, err);
    }

    /* If an ellps argument is specified, start by using that */
    if (0 != ellps_ellps(P))
        return 1;

    /* We may overwrite the size */
    if (0 != ellps_size(P))
        return 2;

    /* We may also overwrite the shape */
    if (0 != ellps_shape(P))
        return 3;

    /* When we're done with it, we compute all related ellipsoid parameters */
    pj_calc_ellipsoid_params(P, P->a, P->es);

    /* And finally, we may turn it into a sphere */
    if (0 != ellps_spherification(P))
        return 4;

    proj_log_trace(P, "pj_ellipsoid - final: a=%.3f f=1/%7.3f, errno=%d", P->a,
                   P->f != 0 ? 1 / P->f : 0, proj_errno(P));
    proj_log_trace(P, "pj_ellipsoid - final: %s %s %s %s",
                   P->def_size ? P->def_size : empty,
                   P->def_shape ? P->def_shape : empty,
                   P->def_spherification ? P->def_spherification : empty,
                   P->def_ellps ? P->def_ellps : empty);

    if (proj_errno(P))
        return 5;

    /* success */
    return proj_errno_restore(P, err);
}

/***************************************************************************************/
static int ellps_ellps(PJ *P) {
    /***************************************************************************************/
    const PJ_ELLPS *ellps;
    paralist *par = nullptr;
    char *name;
    int err;

    /* Sail home if ellps=xxx is not specified */
    par = pj_get_param(P->params, "ellps");
    if (nullptr == par)
        return 0;

    /* Then look up the right size and shape parameters from the builtin list */
    if (strlen(par->param) < 7) {
        proj_log_error(P, _("Invalid value for +ellps"));
        return proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
    }
    name = par->param + 6;
    ellps = pj_find_ellps(name);
    if (nullptr == ellps) {
        proj_log_error(P, _("Unrecognized value for +ellps"));
        return proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
    }

    /* Now, get things ready for ellps_size/ellps_shape, make them do their
     * thing
     */
    err = proj_errno_reset(P);

    paralist *new_params = pj_mkparam(ellps->major);
    if (nullptr == new_params)
        return proj_errno_set(P, PROJ_ERR_OTHER /*ENOMEM*/);
    new_params->next = pj_mkparam(ellps->ell);
    if (nullptr == new_params->next) {
        free(new_params);
        return proj_errno_set(P, PROJ_ERR_OTHER /*ENOMEM*/);
    }
    paralist *old_params = P->params;
    P->params = new_params;

    {
        PJ empty_PJ;
        pj_inherit_ellipsoid_def(&empty_PJ, P);
    }
    const bool errorOnSizeOrShape = (ellps_size(P) || ellps_shape(P));
    P->params = old_params;
    free(new_params->next);
    free(new_params);
    if (errorOnSizeOrShape)
        return proj_errno_set(P, PROJ_ERR_OTHER /*ENOMEM*/);
    if (proj_errno(P))
        return proj_errno(P);

    /* Finally update P and sail home */
    P->def_ellps = pj_strdup(par->param);
    par->used = 1;

    return proj_errno_restore(P, err);
}

/***************************************************************************************/
static int ellps_size(PJ *P) {
    /***************************************************************************************/
    paralist *par = nullptr;
    int a_was_set = 0;

    free(P->def_size);
    P->def_size = nullptr;

    /* A size parameter *must* be given, but may have been given as ellps prior
     */
    if (P->a != 0)
        a_was_set = 1;

    /* Check which size key is specified */
    par = pj_get_param(P->params, "R");
    if (nullptr == par)
        par = pj_get_param(P->params, "a");
    if (nullptr == par) {
        if (a_was_set)
            return 0;
        if (P->need_ellps)
            proj_log_error(P, _("Major axis not given"));
        return proj_errno_set(P, PROJ_ERR_INVALID_OP_MISSING_ARG);
    }

    P->def_size = pj_strdup(par->param);
    par->used = 1;
    P->a = pj_atof(pj_param_value(par));
    if (P->a <= 0) {
        proj_log_error(P, _("Invalid value for major axis"));
        return proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
    }
    if (HUGE_VAL == P->a) {
        proj_log_error(P, _("Invalid value for major axis"));
        return proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
    }

    if ('R' == par->param[0]) {
        P->es = P->f = P->e = P->rf = 0;
        P->b = P->a;
    }
    return 0;
}

/***************************************************************************************/
static int ellps_shape(PJ *P) {
    /***************************************************************************************/
    const char *keys[] = {"rf", "f", "es", "e", "b"};
    paralist *par = nullptr;
    size_t i, len;

    par = nullptr;
    len = sizeof(keys) / sizeof(char *);

    free(P->def_shape);
    P->def_shape = nullptr;

    /* Check which shape key is specified */
    for (i = 0; i < len; i++) {
        par = pj_get_param(P->params, keys[i]);
        if (par)
            break;
    }

    /* Not giving a shape parameter means selecting a sphere, unless shape */
    /* has been selected previously via ellps=xxx */
    if (nullptr == par && P->es != 0)
        return 0;
    if (nullptr == par && P->es == 0) {
        P->es = P->f = 0;
        P->b = P->a;
        return 0;
    }

    P->def_shape = pj_strdup(par->param);
    par->used = 1;
    P->es = P->f = P->b = P->e = P->rf = 0;

    switch (i) {

    /* reverse flattening, rf */
    case 0:
        P->rf = pj_atof(pj_param_value(par));
        if (HUGE_VAL == P->rf || P->rf <= 0) {
            proj_log_error(P, _("Invalid value for rf. Should be > 0"));
            return proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
        }
        P->f = 1 / P->rf;
        P->es = 2 * P->f - P->f * P->f;
        break;

    /* flattening, f */
    case 1:
        P->f = pj_atof(pj_param_value(par));
        if (HUGE_VAL == P->f || P->f < 0) {
            proj_log_error(P, _("Invalid value for f. Should be >= 0"));
            return proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
        }

        P->rf = P->f != 0.0 ? 1.0 / P->f : HUGE_VAL;
        P->es = 2 * P->f - P->f * P->f;
        break;

    /* eccentricity squared, es */
    case 2:
        P->es = pj_atof(pj_param_value(par));
        if (HUGE_VAL == P->es || P->es < 0 || P->es >= 1) {
            proj_log_error(P,
                           _("Invalid value for es. Should be in [0,1[ range"));
            return proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
        }
        break;

    /* eccentricity, e */
    case 3:
        P->e = pj_atof(pj_param_value(par));
        if (HUGE_VAL == P->e || P->e < 0 || P->e >= 1) {
            proj_log_error(P,
                           _("Invalid value for e. Should be in [0,1[ range"));
            return proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
        }
        P->es = P->e * P->e;
        break;

    /* semiminor axis, b */
    case 4:
        P->b = pj_atof(pj_param_value(par));
        if (HUGE_VAL == P->b || P->b <= 0) {
            proj_log_error(P, _("Invalid value for b. Should be > 0"));
            return proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
        }
        if (P->b == P->a)
            break;
        // coverity[division_by_zero]
        P->f = (P->a - P->b) / P->a;
        P->es = 2 * P->f - P->f * P->f;
        break;
    default:
        // shouldn't happen
        return PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE;
    }

    // Written that way to catch NaN
    if (!(P->es >= 0)) {
        proj_log_error(P, _("Invalid eccentricity"));
        return proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
    }
    return 0;
}

/* series coefficients for calculating ellipsoid-equivalent spheres */
static const double SIXTH = 1 / 6.;
static const double RA4 = 17 / 360.;
static const double RA6 = 67 / 3024.;
static const double RV4 = 5 / 72.;
static const double RV6 = 55 / 1296.;

/***************************************************************************************/
static int ellps_spherification(PJ *P) {
    /***************************************************************************************/
    const char *keys[] = {"R_A", "R_V",     "R_a",     "R_g",
                          "R_h", "R_lat_a", "R_lat_g", "R_C"};
    size_t len, i;
    paralist *par = nullptr;

    double t;
    char *v, *endp;

    len = sizeof(keys) / sizeof(char *);

    /* Check which spherification key is specified */
    for (i = 0; i < len; i++) {
        par = pj_get_param(P->params, keys[i]);
        if (par)
            break;
    }

    /* No spherification specified? Then we're done */
    if (i == len)
        return 0;

    /* Store definition */
    P->def_spherification = pj_strdup(par->param);
    par->used = 1;

    switch (i) {

    /* R_A - a sphere with same area as ellipsoid */
    case 0:
        P->a *= 1. - P->es * (SIXTH + P->es * (RA4 + P->es * RA6));
        break;

    /* R_V - a sphere with same volume as ellipsoid */
    case 1:
        P->a *= 1. - P->es * (SIXTH + P->es * (RV4 + P->es * RV6));
        break;

    /* R_a - a sphere with R = the arithmetic mean of the ellipsoid */
    case 2:
        P->a = (P->a + P->b) / 2;
        break;

    /* R_g - a sphere with R = the geometric mean of the ellipsoid */
    case 3:
        P->a = sqrt(P->a * P->b);
        break;

    /* R_h - a sphere with R = the harmonic mean of the ellipsoid */
    case 4:
        if (P->a + P->b == 0)
            return proj_errno_set(
                P, PROJ_ERR_COORD_TRANSFM_OUTSIDE_PROJECTION_DOMAIN);
        P->a = (2 * P->a * P->b) / (P->a + P->b);
        break;

    /* R_lat_a - a sphere with R = the arithmetic mean of the ellipsoid at given
     * latitude */
    case 5:
    /* R_lat_g - a sphere with R = the geometric  mean of the ellipsoid at given
     * latitude */
    case 6:
        v = pj_param_value(par);
        t = proj_dmstor(v, &endp);
        if (fabs(t) > M_HALFPI) {
            proj_log_error(
                P, _("Invalid value for lat_g. |lat_g| should be <= 90°"));
            return proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
        }
        t = sin(t);
        t = 1 - P->es * t * t;
        if (t == 0.) {
            proj_log_error(P, _("Invalid eccentricity"));
            return proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
        }
        if (i == 5) /* arithmetic */
            P->a *= (1. - P->es + t) / (2 * t * sqrt(t));
        else /* geometric */
            P->a *= sqrt(1 - P->es) / t;
        break;

    /* R_C - a sphere with R = radius of conformal sphere, taken at a
     * latitude that is phi0 (note: at least for mercator. for other
     * projection methods, this could be phi1)
     * Formula from IOGP Publication 373-7-2 – Geomatics Guidance Note number 7,
     * part 2 1.1 Ellipsoid parameters
     */
    case 7:
        t = sin(P->phi0);
        t = 1 - P->es * t * t;
        if (t == 0.) {
            proj_log_error(P, _("Invalid eccentricity"));
            return proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
        }
        P->a *= sqrt(1 - P->es) / t;
        break;
    }

    if (P->a <= 0.) {
        proj_log_error(P, _("Invalid or missing major axis"));
        return proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
    }

    /* Clean up the ellipsoidal parameters to reflect the sphere */
    P->es = P->e = P->f = 0;
    P->rf = HUGE_VAL;
    P->b = P->a;
    pj_calc_ellipsoid_params(P, P->a, 0);

    return 0;
}

/* locate parameter in list */
static paralist *pj_get_param(paralist *list, const char *key) {
    size_t l = strlen(key);
    while (list && !(0 == strncmp(list->param, key, l) &&
                     (0 == list->param[l] || list->param[l] == '=')))
        list = list->next;
    return list;
}

static char *pj_param_value(paralist *list) {
    char *key, *value;
    if (nullptr == list)
        return nullptr;

    key = list->param;
    value = strchr(key, '=');

    /* a flag (i.e. a key without value) has its own name (key) as value */
    return value ? value + 1 : key;
}

static const PJ_ELLPS *pj_find_ellps(const char *name) {
    int i;
    const char *s;
    const PJ_ELLPS *ellps;

    if (nullptr == name)
        return nullptr;

    ellps = proj_list_ellps();

    /* Search through internal ellipsoid list for name */
    for (i = 0; (s = ellps[i].id) && strcmp(name, s); ++i)
        ;
    if (nullptr == s)
        return nullptr;
    return ellps + i;
}

/**************************************************************************************/
void pj_inherit_ellipsoid_def(const PJ *src, PJ *dst) {
    /***************************************************************************************
        Brute force copy the ellipsoidal parameters from src to dst.  This code
    was written before the actual ellipsoid setup parameters were kept available
    in the PJ->def_xxx elements.
    ***************************************************************************************/

    /* The linear parameters */
    dst->a = src->a;
    dst->b = src->b;
    dst->ra = src->ra;
    dst->rb = src->rb;

    /* The eccentricities */
    dst->alpha = src->alpha;
    dst->e = src->e;
    dst->es = src->es;
    dst->e2 = src->e2;
    dst->e2s = src->e2s;
    dst->e3 = src->e3;
    dst->e3s = src->e3s;
    dst->one_es = src->one_es;
    dst->rone_es = src->rone_es;

    /* The flattenings */
    dst->f = src->f;
    dst->f2 = src->f2;
    dst->n = src->n;
    dst->rf = src->rf;
    dst->rf2 = src->rf2;
    dst->rn = src->rn;

    /* This one's for GRS80 */
    dst->J = src->J;

    /* es and a before any +proj related adjustment */
    dst->es_orig = src->es_orig;
    dst->a_orig = src->a_orig;
}

/***************************************************************************************/
int pj_calc_ellipsoid_params(PJ *P, double a, double es) {
    /****************************************************************************************
        Calculate a large number of ancillary ellipsoidal parameters, in
    addition to the two traditional PROJ defining parameters: Semimajor axis, a,
    and the eccentricity squared, es.

        Most of these parameters are fairly cheap to compute in comparison to
    the overall effort involved in initializing a PJ object. They may, however,
    take a substantial part of the time taken in computing an individual point
    transformation.

        So by providing them up front, we can amortize the (already modest) cost
    over all transformations carried out over the entire lifetime of a PJ
    object, rather than incur that cost for every single transformation.

        Most of the parameter calculations here are based on the "angular
    eccentricity", i.e. the angle, measured from the semiminor axis, of a line
    going from the north pole to one of the foci of the ellipsoid - or in other
    words: The arc sine of the eccentricity.

        The formulae used are mostly taken from:

        Richard H. Rapp: Geometric Geodesy, Part I, (178 pp, 1991).
        Columbus, Ohio:  Dept. of Geodetic Science
        and Surveying, Ohio State University.

    ****************************************************************************************/

    P->a = a;
    P->es = es;

    /* Compute some ancillary ellipsoidal parameters */
    if (P->e == 0)
        P->e = sqrt(P->es); /* eccentricity */
    P->alpha = asin(P->e);  /* angular eccentricity */

    /* second eccentricity */
    P->e2 = tan(P->alpha);
    P->e2s = P->e2 * P->e2;

    /* third eccentricity */
    P->e3 = (0 != P->alpha)
                ? sin(P->alpha) / sqrt(2 - sin(P->alpha) * sin(P->alpha))
                : 0;
    P->e3s = P->e3 * P->e3;

    /* flattening */
    if (0 == P->f)
        P->f = 1 - cos(P->alpha); /* = 1 - sqrt (1 - PIN->es); */
    if (!(P->f >= 0.0 && P->f < 1.0)) {
        proj_log_error(P, _("Invalid eccentricity"));
        proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
        return PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE;
    }
    P->rf = P->f != 0.0 ? 1.0 / P->f : HUGE_VAL;

    /* second flattening */
    P->f2 = (cos(P->alpha) != 0) ? 1 / cos(P->alpha) - 1 : 0;
    P->rf2 = P->f2 != 0.0 ? 1 / P->f2 : HUGE_VAL;

    /* third flattening */
    P->n = pow(tan(P->alpha / 2), 2);
    P->rn = P->n != 0.0 ? 1 / P->n : HUGE_VAL;

    /* ...and a few more */
    if (0 == P->b)
        P->b = (1 - P->f) * P->a;
    P->rb = 1. / P->b;
    P->ra = 1. / P->a;

    P->one_es = 1. - P->es;
    if (P->one_es == 0.) {
        proj_log_error(P, _("Invalid eccentricity"));
        proj_errno_set(P, PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE);
        return PROJ_ERR_INVALID_OP_ILLEGAL_ARG_VALUE;
    }

    P->rone_es = 1. / P->one_es;

    return 0;
}

/**************************************************************************************/
int pj_ell_set(PJ_CONTEXT *ctx, paralist *pl, double *a, double *es) {
    /***************************************************************************************
        Initialize ellipsoidal parameters by emulating the original ellipsoid
    setup function by Gerald Evenden, through a call to pj_ellipsoid
    ***************************************************************************************/
    PJ B;
    int ret;

    B.ctx = ctx;
    B.params = pl;

    ret = pj_ellipsoid(&B);

    free(B.def_size);
    free(B.def_shape);
    free(B.def_spherification);
    free(B.def_ellps);

    if (ret)
        return ret;

    *a = B.a;
    *es = B.es;
    return 0;
}

Coverage Report

Created: 2026-04-10 07:04