boost/geometry/srs/projections/proj/fouc_s.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_FOUC_S_HPP
  41 #define BOOST_GEOMETRY_PROJECTIONS_FOUC_S_HPP
  42
  43 #include <boost/geometry/srs/projections/impl/aasincos.hpp>
  44 #include <boost/geometry/srs/projections/impl/base_static.hpp>
  45 #include <boost/geometry/srs/projections/impl/base_dynamic.hpp>
  46 #include <boost/geometry/srs/projections/impl/factory_entry.hpp>
  47 #include <boost/geometry/srs/projections/impl/pj_param.hpp>
  48 #include <boost/geometry/srs/projections/impl/projects.hpp>
  49
  50 #include <boost/geometry/util/math.hpp>
  51
  52 namespace boost { namespace geometry
  53 {
  54
  55 namespace projections
  56 {
  57     #ifndef DOXYGEN_NO_DETAIL
  58     namespace detail { namespace fouc_s
  59     {
  60
  61             static const int max_iter = 10;
  62             static const double loop_tol = 1e-7;
  63
  64             template <typename T>
  65             struct par_fouc_s
  66             {
  67                 T n, n1;
  68             };
  69
  70             template <typename T, typename Parameters>
  71             struct base_fouc_s_spheroid
  72             {
  73                 par_fouc_s<T> m_proj_parm;
  74
  75                 // FORWARD(s_forward)  spheroid
  76                 // Project coordinates from geographic (lon, lat) to cartesian (x, y)
  77                 inline void fwd(Parameters const& , T const& lp_lon, T const& lp_lat, T& xy_x, T& xy_y) const
  78                 {
  79                     T t;
  80
  81                     t = cos(lp_lat);
  82                     xy_x = lp_lon * t / (this->m_proj_parm.n + this->m_proj_parm.n1 * t);
  83                     xy_y = this->m_proj_parm.n * lp_lat + this->m_proj_parm.n1 * sin(lp_lat);
  84                 }
  85
  86                 // INVERSE(s_inverse)  spheroid
  87                 // Project coordinates from cartesian (x, y) to geographic (lon, lat)
  88                 inline void inv(Parameters const& , T const& xy_x, T const& xy_y, T& lp_lon, T& lp_lat) const
  89                 {
  90                     static T const half_pi = detail::half_pi<T>();
  91
  92                     T V;
  93                     int i;
  94
  95                     if (this->m_proj_parm.n != 0.0) {
  96                         lp_lat = xy_y;
  97                         for (i = max_iter; i ; --i) {
  98                             lp_lat -= V = (this->m_proj_parm.n * lp_lat + this->m_proj_parm.n1 * sin(lp_lat) - xy_y ) /
  99                                 (this->m_proj_parm.n + this->m_proj_parm.n1 * cos(lp_lat));
 100                             if (fabs(V) < loop_tol)
 101                                 break;
 102                         }
 103                         if (!i)
 104                             lp_lat = xy_y < 0. ? -half_pi : half_pi;
 105                     } else
 106                         lp_lat = aasin(xy_y);
 107                     V = cos(lp_lat);
 108                     lp_lon = xy_x * (this->m_proj_parm.n + this->m_proj_parm.n1 * V) / V;
 109                 }
 110
 111                 static inline std::string get_name()
 112                 {
 113                     return "fouc_s_spheroid";
 114                 }
 115
 116             };
 117
 118             // Foucaut Sinusoidal
 119             template <typename Params, typename Parameters, typename T>
 120             inline void setup_fouc_s(Params const& params, Parameters& par, par_fouc_s<T>& proj_parm)
 121             {
 122                 proj_parm.n = pj_get_param_f<T, srs::spar::n>(params, "n", srs::dpar::n);
 123                 if ((proj_parm.n < 0.) || (proj_parm.n > 1.))
 124                     BOOST_THROW_EXCEPTION( projection_exception(error_n_out_of_range) );
 125
 126                 proj_parm.n1 = 1. - proj_parm.n;
 127                 par.es = 0;
 128             }
 129
 130     }} // namespace detail::fouc_s
 131     #endif // doxygen
 132
 133     /*!
 134         \brief Foucaut Sinusoidal projection
 135         \ingroup projections
 136         \tparam Geographic latlong point type
 137         \tparam Cartesian xy point type
 138         \tparam Parameters parameter type
 139         \par Projection characteristics
 140          - Pseudocylindrical
 141          - Spheroid
 142         \par Projection parameters
 143          - n (real)
 144         \par Example
 145         \image html ex_fouc_s.gif
 146     */
 147     template <typename T, typename Parameters>
 148     struct fouc_s_spheroid : public detail::fouc_s::base_fouc_s_spheroid<T, Parameters>
 149     {
 150         template <typename Params>
 151         inline fouc_s_spheroid(Params const& params, Parameters & par)
 152         {
 153             detail::fouc_s::setup_fouc_s(params, par, this->m_proj_parm);
 154         }
 155     };
 156
 157     #ifndef DOXYGEN_NO_DETAIL
 158     namespace detail
 159     {
 160
 161         // Static projection
 162         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION_FI(srs::spar::proj_fouc_s, fouc_s_spheroid)
 163
 164         // Factory entry(s)
 165         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_ENTRY_FI(fouc_s_entry, fouc_s_spheroid)
 166
 167         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_BEGIN(fouc_s_init)
 168         {
 169             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(fouc_s, fouc_s_entry);
 170         }
 171
 172     } // namespace detail
 173     #endif // doxygen
 174
 175 } // namespace projections
 176
 177 }} // namespace boost::geometry
 178
 179 #endif // BOOST_GEOMETRY_PROJECTIONS_FOUC_S_HPP
 180