Imported Upstream version 1.72.0
[platform/upstream/boost.git] / boost / geometry / srs / projections / proj / mbtfpq.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_MBTFPQ_HPP
41 #define BOOST_GEOMETRY_PROJECTIONS_MBTFPQ_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 mbtfpq
57     {
58
59             static const int n_iter = 20;
60             static const double epsilon = 1e-7;
61             static const double one_plus_tol = 1.000001;
62             static const double C = 1.70710678118654752440;
63             static const double RC = 0.58578643762690495119;
64             static const double FYC = 1.87475828462269495505;
65             static const double RYC = 0.53340209679417701685;
66             static const double FXC = 0.31245971410378249250;
67             static const double RXC = 3.20041258076506210122;
68
69             template <typename T, typename Parameters>
70             struct base_mbtfpq_spheroid
71             {
72                 // FORWARD(s_forward)  spheroid
73                 // Project coordinates from geographic (lon, lat) to cartesian (x, y)
74                 inline void fwd(Parameters const& , T const& lp_lon, T lp_lat, T& xy_x, T& xy_y) const
75                 {
76                     T th1, c;
77                     int i;
78
79                     c = C * sin(lp_lat);
80                     for (i = n_iter; i; --i) {
81                         lp_lat -= th1 = (sin(.5*lp_lat) + sin(lp_lat) - c) /
82                             (.5*cos(.5*lp_lat)  + cos(lp_lat));
83                         if (fabs(th1) < epsilon) break;
84                     }
85                     xy_x = FXC * lp_lon * (1.0 + 2. * cos(lp_lat)/cos(0.5 * lp_lat));
86                     xy_y = FYC * sin(0.5 * lp_lat);
87                 }
88
89                 // INVERSE(s_inverse)  spheroid
90                 // Project coordinates from cartesian (x, y) to geographic (lon, lat)
91                 inline void inv(Parameters const& , T const& xy_x, T const& xy_y, T& lp_lon, T& lp_lat) const
92                 {
93                     static const T pi = detail::pi<T>();
94                     static const T half_pi = detail::half_pi<T>();
95
96                     T t;
97
98                     lp_lat = RYC * xy_y;
99                     if (fabs(lp_lat) > 1.) {
100                         if (fabs(lp_lat) > one_plus_tol) {
101                             BOOST_THROW_EXCEPTION( projection_exception(error_tolerance_condition) );
102                         } else if (lp_lat < 0.) {
103                             t = -1.; lp_lat = -pi;
104                         } else {
105                             t = 1.; lp_lat = pi;
106                         }
107                     } else
108                         lp_lat = 2. * asin(t = lp_lat);
109                     lp_lon = RXC * xy_x / (1. + 2. * cos(lp_lat)/cos(0.5 * lp_lat));
110                     lp_lat = RC * (t + sin(lp_lat));
111                     if (fabs(lp_lat) > 1.)
112                         if (fabs(lp_lat) > one_plus_tol) {
113                             BOOST_THROW_EXCEPTION( projection_exception(error_tolerance_condition) );
114                         } else
115                             lp_lat = lp_lat < 0. ? -half_pi : half_pi;
116                     else
117                         lp_lat = asin(lp_lat);
118                 }
119
120                 static inline std::string get_name()
121                 {
122                     return "mbtfpq_spheroid";
123                 }
124
125             };
126
127             // McBryde-Thomas Flat-Polar Quartic
128             template <typename Parameters>
129             inline void setup_mbtfpq(Parameters& par)
130             {
131                 par.es = 0.;
132             }
133
134     }} // namespace detail::mbtfpq
135     #endif // doxygen
136
137     /*!
138         \brief McBryde-Thomas Flat-Polar Quartic projection
139         \ingroup projections
140         \tparam Geographic latlong point type
141         \tparam Cartesian xy point type
142         \tparam Parameters parameter type
143         \par Projection characteristics
144          - Cylindrical
145          - Spheroid
146         \par Example
147         \image html ex_mbtfpq.gif
148     */
149     template <typename T, typename Parameters>
150     struct mbtfpq_spheroid : public detail::mbtfpq::base_mbtfpq_spheroid<T, Parameters>
151     {
152         template <typename Params>
153         inline mbtfpq_spheroid(Params const& , Parameters & par)
154         {
155             detail::mbtfpq::setup_mbtfpq(par);
156         }
157     };
158
159     #ifndef DOXYGEN_NO_DETAIL
160     namespace detail
161     {
162
163         // Static projection
164         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION_FI(srs::spar::proj_mbtfpq, mbtfpq_spheroid)
165
166         // Factory entry(s)
167         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_ENTRY_FI(mbtfpq_entry, mbtfpq_spheroid)
168         
169         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_BEGIN(mbtfpq_init)
170         {
171             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(mbtfpq, mbtfpq_entry)
172         }
173
174     } // namespace detail
175     #endif // doxygen
176
177 } // namespace projections
178
179 }} // namespace boost::geometry
180
181 #endif // BOOST_GEOMETRY_PROJECTIONS_MBTFPQ_HPP
182