Imported Upstream version 1.72.0
[platform/upstream/boost.git] / boost / geometry / srs / projections / proj / boggs.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_BOGGS_HPP
41 #define BOOST_GEOMETRY_PROJECTIONS_BOGGS_HPP
42
43 #include <boost/geometry/util/math.hpp>
44
45 #include <boost/geometry/srs/projections/impl/base_static.hpp>
46 #include <boost/geometry/srs/projections/impl/base_dynamic.hpp>
47 #include <boost/geometry/srs/projections/impl/projects.hpp>
48 #include <boost/geometry/srs/projections/impl/factory_entry.hpp>
49
50 namespace boost { namespace geometry
51 {
52
53 namespace projections
54 {
55     #ifndef DOXYGEN_NO_DETAIL
56     namespace detail { namespace boggs
57     {
58
59             static const int n_iter = 20;
60             static const double epsilon = 1e-7;
61             static const double FXC = 2.00276;
62             static const double FXC2 = 1.11072;
63             static const double FYC = 0.49931;
64
65             template <typename T, typename Parameters>
66             struct base_boggs_spheroid
67             {
68                 // FORWARD(s_forward)  spheroid
69                 // Project coordinates from geographic (lon, lat) to cartesian (x, y)
70                 inline void fwd(Parameters const& , 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                     static const T pi = detail::pi<T>();
74                     static const T root_two = boost::math::constants::root_two<T>();
75
76                     T theta, th1, c;
77                     int i;
78
79                     theta = lp_lat;
80                     if (fabs(fabs(lp_lat) - half_pi) < epsilon)
81                         xy_x = 0.;
82                     else {
83                         c = sin(theta) * pi;
84                         for (i = n_iter; i; --i) {
85                             theta -= th1 = (theta + sin(theta) - c) /
86                                 (1. + cos(theta));
87                             if (fabs(th1) < epsilon) break;
88                         }
89                         theta *= 0.5;
90                         xy_x = FXC * lp_lon / (1. / cos(lp_lat) + FXC2 / cos(theta));
91                     }
92                     xy_y = FYC * (lp_lat + root_two * sin(theta));
93                 }
94
95                 static inline std::string get_name()
96                 {
97                     return "boggs_spheroid";
98                 }
99
100             };
101
102             // Boggs Eumorphic
103             template <typename Parameters>
104             inline void setup_boggs(Parameters& par)
105             {
106                 par.es = 0.;
107             }
108
109     }} // namespace detail::boggs
110     #endif // doxygen
111
112     /*!
113         \brief Boggs Eumorphic projection
114         \ingroup projections
115         \tparam Geographic latlong point type
116         \tparam Cartesian xy point type
117         \tparam Parameters parameter type
118         \par Projection characteristics
119          - Pseudocylindrical
120          - no inverse
121          - Spheroid
122         \par Example
123         \image html ex_boggs.gif
124     */
125     template <typename T, typename Parameters>
126     struct boggs_spheroid : public detail::boggs::base_boggs_spheroid<T, Parameters>
127     {
128         template <typename Params>
129         inline boggs_spheroid(Params const& , Parameters & par)
130         {
131             detail::boggs::setup_boggs(par);
132         }
133     };
134
135     #ifndef DOXYGEN_NO_DETAIL
136     namespace detail
137     {
138
139         // Static projection
140         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION_F(srs::spar::proj_boggs, boggs_spheroid)
141
142         // Factory entry(s)
143         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_ENTRY_F(boggs_entry, boggs_spheroid)
144
145         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_BEGIN(boggs_init)
146         {
147             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(boggs, boggs_entry);
148         }
149
150     } // namespace detail
151     #endif // doxygen
152
153 } // namespace projections
154
155 }} // namespace boost::geometry
156
157 #endif // BOOST_GEOMETRY_PROJECTIONS_BOGGS_HPP
158