boost/geometry/srs/projections/proj/hammer.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_HAMMER_HPP
  41 #define BOOST_GEOMETRY_PROJECTIONS_HAMMER_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_param.hpp>
  47 #include <boost/geometry/srs/projections/impl/projects.hpp>
  48
  49 namespace boost { namespace geometry
  50 {
  51
  52 namespace projections
  53 {
  54     #ifndef DOXYGEN_NO_DETAIL
  55     namespace detail { namespace hammer
  56     {
  57             static const double epsilon = 1.0e-10;
  58
  59             template <typename T>
  60             struct par_hammer
  61             {
  62                 T w;
  63                 T m, rm;
  64             };
  65
  66             template <typename T, typename Parameters>
  67             struct base_hammer_spheroid
  68             {
  69                 par_hammer<T> m_proj_parm;
  70
  71                 // FORWARD(s_forward)  spheroid
  72                 // Project coordinates from geographic (lon, lat) to cartesian (x, y)
  73                 inline void fwd(Parameters const& , T lp_lon, T const& lp_lat, T& xy_x, T& xy_y) const
  74                 {
  75                     T cosphi, d;
  76
  77                     d = sqrt(2./(1. + (cosphi = cos(lp_lat)) * cos(lp_lon *= this->m_proj_parm.w)));
  78                     xy_x = this->m_proj_parm.m * d * cosphi * sin(lp_lon);
  79                     xy_y = this->m_proj_parm.rm * d * sin(lp_lat);
  80                 }
  81
  82                 // INVERSE(s_inverse)  spheroid
  83                 // Project coordinates from cartesian (x, y) to geographic (lon, lat)
  84                 inline void inv(Parameters const& , T const& xy_x, T const& xy_y, T& lp_lon, T& lp_lat) const
  85                 {
  86                     T z;
  87
  88                     z = sqrt(1. - 0.25*this->m_proj_parm.w*this->m_proj_parm.w*xy_x*xy_x - 0.25*xy_y*xy_y);
  89                     if (geometry::math::abs(2.*z*z-1.) < epsilon) {
  90                         lp_lon = HUGE_VAL;
  91                         lp_lat = HUGE_VAL;
  92                         BOOST_THROW_EXCEPTION( projection_exception(error_lat_or_lon_exceed_limit) );
  93                     } else {
  94                         lp_lon = aatan2(this->m_proj_parm.w * xy_x * z,2. * z * z - 1)/this->m_proj_parm.w;
  95                         lp_lat = aasin(z * xy_y);
  96                     }
  97                 }
  98
  99                 static inline std::string get_name()
 100                 {
 101                     return "hammer_spheroid";
 102                 }
 103
 104             };
 105
 106             // Hammer & Eckert-Greifendorff
 107             template <typename Params, typename Parameters, typename T>
 108             inline void setup_hammer(Params const& params, Parameters& par, par_hammer<T>& proj_parm)
 109             {
 110                 T tmp;
 111
 112                 if (pj_param_f<srs::spar::w>(params, "W", srs::dpar::w, tmp)) {
 113                     if ((proj_parm.w = fabs(tmp)) <= 0.)
 114                         BOOST_THROW_EXCEPTION( projection_exception(error_w_or_m_zero_or_less) );
 115                 } else
 116                     proj_parm.w = .5;
 117                 if (pj_param_f<srs::spar::m>(params, "M", srs::dpar::m, tmp)) {
 118                     if ((proj_parm.m = fabs(tmp)) <= 0.)
 119                         BOOST_THROW_EXCEPTION( projection_exception(error_w_or_m_zero_or_less) );
 120                 } else
 121                     proj_parm.m = 1.;
 122
 123                 proj_parm.rm = 1. / proj_parm.m;
 124                 proj_parm.m /= proj_parm.w;
 125
 126                 par.es = 0.;
 127             }
 128
 129     }} // namespace detail::hammer
 130     #endif // doxygen
 131
 132     /*!
 133         \brief Hammer & Eckert-Greifendorff projection
 134         \ingroup projections
 135         \tparam Geographic latlong point type
 136         \tparam Cartesian xy point type
 137         \tparam Parameters parameter type
 138         \par Projection characteristics
 139          - Miscellaneous
 140          - Spheroid
 141          - no inverse
 142         \par Projection parameters
 143          - W (real)
 144          - M (real)
 145         \par Example
 146         \image html ex_hammer.gif
 147     */
 148     template <typename T, typename Parameters>
 149     struct hammer_spheroid : public detail::hammer::base_hammer_spheroid<T, Parameters>
 150     {
 151         template <typename Params>
 152         inline hammer_spheroid(Params const& params, Parameters & par)
 153         {
 154             detail::hammer::setup_hammer(params, par, this->m_proj_parm);
 155         }
 156     };
 157
 158     #ifndef DOXYGEN_NO_DETAIL
 159     namespace detail
 160     {
 161
 162         // Static projection
 163         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION_FI(srs::spar::proj_hammer, hammer_spheroid)
 164
 165         // Factory entry(s)
 166         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_ENTRY_FI(hammer_entry, hammer_spheroid)
 167
 168         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_BEGIN(hammer_init)
 169         {
 170             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(hammer, hammer_entry)
 171         }
 172
 173     } // namespace detail
 174     #endif // doxygen
 175
 176 } // namespace projections
 177
 178 }} // namespace boost::geometry
 179
 180 #endif // BOOST_GEOMETRY_PROJECTIONS_HAMMER_HPP
 181