boost/geometry/srs/projections/proj/merc.hpp

   1 // Boost.Geometry - gis-projections (based on PROJ4)
   2
   3 // Copyright (c) 2008-2015 Barend Gehrels, Amsterdam, the Netherlands.
   4
   5 // This file was modified by Oracle on 2017, 2018, 2019.
   6 // Modifications copyright (c) 2017-2019, Oracle and/or its affiliates.
   7 // Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle.
   8
   9 // Use, modification and distribution is subject to the Boost Software License,
  10 // Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  11 // http://www.boost.org/LICENSE_1_0.txt)
  12
  13 // This file is converted from PROJ4, http://trac.osgeo.org/proj
  14 // PROJ4 is originally written by Gerald Evenden (then of the USGS)
  15 // PROJ4 is maintained by Frank Warmerdam
  16 // PROJ4 is converted to Boost.Geometry by Barend Gehrels
  17
  18 // Last updated version of proj: 5.0.0
  19
  20 // Original copyright notice:
  21
  22 // Permission is hereby granted, free of charge, to any person obtaining a
  23 // copy of this software and associated documentation files (the "Software"),
  24 // to deal in the Software without restriction, including without limitation
  25 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  26 // and/or sell copies of the Software, and to permit persons to whom the
  27 // Software is furnished to do so, subject to the following conditions:
  28
  29 // The above copyright notice and this permission notice shall be included
  30 // in all copies or substantial portions of the Software.
  31
  32 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  33 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  34 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  35 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  36 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  37 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  38 // DEALINGS IN THE SOFTWARE.
  39
  40 #ifndef BOOST_GEOMETRY_PROJECTIONS_MERC_HPP
  41 #define BOOST_GEOMETRY_PROJECTIONS_MERC_HPP
  42
  43 #include <boost/geometry/srs/projections/impl/base_static.hpp>
  44 #include <boost/geometry/srs/projections/impl/base_dynamic.hpp>
  45 #include <boost/geometry/srs/projections/impl/factory_entry.hpp>
  46 #include <boost/geometry/srs/projections/impl/pj_msfn.hpp>
  47 #include <boost/geometry/srs/projections/impl/pj_param.hpp>
  48 #include <boost/geometry/srs/projections/impl/pj_phi2.hpp>
  49 #include <boost/geometry/srs/projections/impl/pj_tsfn.hpp>
  50 #include <boost/geometry/srs/projections/impl/projects.hpp>
  51
  52 #include <boost/geometry/util/math.hpp>
  53
  54 namespace boost { namespace geometry
  55 {
  56
  57 namespace projections
  58 {
  59     #ifndef DOXYGEN_NO_DETAIL
  60     namespace detail { namespace merc
  61     {
  62
  63             static const double epsilon10 = 1.e-10;
  64
  65             template <typename T, typename Parameters>
  66             struct base_merc_ellipsoid
  67             {
  68                 // FORWARD(e_forward)  ellipsoid
  69                 // Project coordinates from geographic (lon, lat) to cartesian (x, y)
  70                 inline void fwd(Parameters const& par, T const& lp_lon, T const& lp_lat, T& xy_x, T& xy_y) const
  71                 {
  72                     static const T half_pi = detail::half_pi<T>();
  73
  74                     if (fabs(fabs(lp_lat) - half_pi) <= epsilon10) {
  75                         BOOST_THROW_EXCEPTION( projection_exception(error_tolerance_condition) );
  76                     }
  77                     xy_x = par.k0 * lp_lon;
  78                     xy_y = - par.k0 * log(pj_tsfn(lp_lat, sin(lp_lat), par.e));
  79                 }
  80
  81                 // INVERSE(e_inverse)  ellipsoid
  82                 // Project coordinates from cartesian (x, y) to geographic (lon, lat)
  83                 inline void inv(Parameters const& par, T const& xy_x, T const& xy_y, T& lp_lon, T& lp_lat) const
  84                 {
  85                     if ((lp_lat = pj_phi2(exp(- xy_y / par.k0), par.e)) == HUGE_VAL) {
  86                         BOOST_THROW_EXCEPTION( projection_exception(error_tolerance_condition) );
  87                     }
  88                     lp_lon = xy_x / par.k0;
  89                 }
  90
  91                 static inline std::string get_name()
  92                 {
  93                     return "merc_ellipsoid";
  94                 }
  95
  96             };
  97
  98             template <typename T, typename Parameters>
  99             struct base_merc_spheroid
 100             {
 101                 // FORWARD(s_forward)  spheroid
 102                 // Project coordinates from geographic (lon, lat) to cartesian (x, y)
 103                 inline void fwd(Parameters const& par, T const& lp_lon, T const& lp_lat, T& xy_x, T& xy_y) const
 104                 {
 105                     static const T half_pi = detail::half_pi<T>();
 106                     static const T fourth_pi = detail::fourth_pi<T>();
 107
 108                     if (fabs(fabs(lp_lat) - half_pi) <= epsilon10) {
 109                         BOOST_THROW_EXCEPTION( projection_exception(error_tolerance_condition) );
 110                     }
 111                     xy_x = par.k0 * lp_lon;
 112                     xy_y = par.k0 * log(tan(fourth_pi + .5 * lp_lat));
 113                 }
 114
 115                 // INVERSE(s_inverse)  spheroid
 116                 // Project coordinates from cartesian (x, y) to geographic (lon, lat)
 117                 inline void inv(Parameters const& par, T const& xy_x, T const& xy_y, T& lp_lon, T& lp_lat) const
 118                 {
 119                     static const T half_pi = detail::half_pi<T>();
 120
 121                     lp_lat = half_pi - 2. * atan(exp(-xy_y / par.k0));
 122                     lp_lon = xy_x / par.k0;
 123                 }
 124
 125                 static inline std::string get_name()
 126                 {
 127                     return "merc_spheroid";
 128                 }
 129
 130             };
 131
 132             // Mercator
 133             template <typename Params, typename Parameters>
 134             inline void setup_merc(Params const& params, Parameters& par)
 135             {
 136                 typedef typename Parameters::type calc_t;
 137                 static const calc_t half_pi = detail::half_pi<calc_t>();
 138
 139                 calc_t phits=0.0;
 140                 int is_phits;
 141
 142                 if( (is_phits = pj_param_r<srs::spar::lat_ts>(params, "lat_ts", srs::dpar::lat_ts, phits)) ) {
 143                     phits = fabs(phits);
 144                     if (phits >= half_pi)
 145                         BOOST_THROW_EXCEPTION( projection_exception(error_lat_ts_larger_than_90) );
 146                 }
 147                 if (par.es != 0.0) { /* ellipsoid */
 148                     if (is_phits)
 149                         par.k0 = pj_msfn(sin(phits), cos(phits), par.es);
 150                 } else { /* sphere */
 151                     if (is_phits)
 152                         par.k0 = cos(phits);
 153                 }
 154             }
 155
 156     }} // namespace detail::merc
 157     #endif // doxygen
 158
 159     /*!
 160         \brief Mercator projection
 161         \ingroup projections
 162         \tparam Geographic latlong point type
 163         \tparam Cartesian xy point type
 164         \tparam Parameters parameter type
 165         \par Projection characteristics
 166          - Cylindrical
 167          - Spheroid
 168          - Ellipsoid
 169         \par Projection parameters
 170          - lat_ts: Latitude of true scale (degrees)
 171         \par Example
 172         \image html ex_merc.gif
 173     */
 174     template <typename T, typename Parameters>
 175     struct merc_ellipsoid : public detail::merc::base_merc_ellipsoid<T, Parameters>
 176     {
 177         template <typename Params>
 178         inline merc_ellipsoid(Params const& params, Parameters & par)
 179         {
 180             detail::merc::setup_merc(params, par);
 181         }
 182     };
 183
 184     /*!
 185         \brief Mercator projection
 186         \ingroup projections
 187         \tparam Geographic latlong point type
 188         \tparam Cartesian xy point type
 189         \tparam Parameters parameter type
 190         \par Projection characteristics
 191          - Cylindrical
 192          - Spheroid
 193          - Ellipsoid
 194         \par Projection parameters
 195          - lat_ts: Latitude of true scale (degrees)
 196         \par Example
 197         \image html ex_merc.gif
 198     */
 199     template <typename T, typename Parameters>
 200     struct merc_spheroid : public detail::merc::base_merc_spheroid<T, Parameters>
 201     {
 202         template <typename Params>
 203         inline merc_spheroid(Params const& params, Parameters & par)
 204         {
 205             detail::merc::setup_merc(params, par);
 206         }
 207     };
 208
 209     #ifndef DOXYGEN_NO_DETAIL
 210     namespace detail
 211     {
 212
 213         // Static projection
 214         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION_FI2(srs::spar::proj_merc, merc_spheroid, merc_ellipsoid)
 215
 216         // Factory entry(s)
 217         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_ENTRY_FI2(merc_entry, merc_spheroid, merc_ellipsoid)
 218
 219         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_BEGIN(merc_init)
 220         {
 221             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(merc, merc_entry)
 222         }
 223
 224     } // namespace detail
 225     #endif // doxygen
 226
 227 } // namespace projections
 228
 229 }} // namespace boost::geometry
 230
 231 #endif // BOOST_GEOMETRY_PROJECTIONS_MERC_HPP
 232