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.
6 // Modifications copyright (c) 2017-2018, 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_TPEQD_HPP
41 #define BOOST_GEOMETRY_PROJECTIONS_TPEQD_HPP
42 
43 #include <boost/geometry/util/math.hpp>
44 #include <boost/math/special_functions/hypot.hpp>
45 
46 #include <boost/geometry/srs/projections/impl/aasincos.hpp>
47 #include <boost/geometry/srs/projections/impl/base_static.hpp>
48 #include <boost/geometry/srs/projections/impl/base_dynamic.hpp>
49 #include <boost/geometry/srs/projections/impl/factory_entry.hpp>
50 #include <boost/geometry/srs/projections/impl/pj_param.hpp>
51 #include <boost/geometry/srs/projections/impl/projects.hpp>
52 
53 namespace boost { namespace geometry
54 {
55 
56 namespace projections
57 {
58     #ifndef DOXYGEN_NO_DETAIL
59     namespace detail { namespace tpeqd
60     {
61             template <typename T>
62             struct par_tpeqd
63             {
64                 T cp1, sp1, cp2, sp2, ccs, cs, sc, r2z0, z02, dlam2;
65                 T hz0, thz0, rhshz0, ca, sa, lp, lamc;
66             };
67 
68             // template class, using CRTP to implement forward/inverse
69             template <typename T, typename Parameters>
70             struct base_tpeqd_spheroid
71                 : public base_t_fi<base_tpeqd_spheroid<T, Parameters>, T, Parameters>
72             {
73                 par_tpeqd<T> m_proj_parm;
74 
base_tpeqd_spheroidboost::geometry::projections::detail::tpeqd::base_tpeqd_spheroid75                 inline base_tpeqd_spheroid(const Parameters& par)
76                     : base_t_fi<base_tpeqd_spheroid<T, Parameters>, T, Parameters>(*this, par)
77                 {}
78 
79                 // FORWARD(s_forward)  sphere
80                 // Project coordinates from geographic (lon, lat) to cartesian (x, y)
fwdboost::geometry::projections::detail::tpeqd::base_tpeqd_spheroid81                 inline void fwd(T const& lp_lon, T const& lp_lat, T& xy_x, T& xy_y) const
82                 {
83                     T t, z1, z2, dl1, dl2, sp, cp;
84 
85                     sp = sin(lp_lat);
86                     cp = cos(lp_lat);
87                     z1 = aacos(this->m_proj_parm.sp1 * sp + this->m_proj_parm.cp1 * cp * cos(dl1 = lp_lon + this->m_proj_parm.dlam2));
88                     z2 = aacos(this->m_proj_parm.sp2 * sp + this->m_proj_parm.cp2 * cp * cos(dl2 = lp_lon - this->m_proj_parm.dlam2));
89                     z1 *= z1;
90                     z2 *= z2;
91 
92                     xy_x = this->m_proj_parm.r2z0 * (t = z1 - z2);
93                     t = this->m_proj_parm.z02 - t;
94                     xy_y = this->m_proj_parm.r2z0 * asqrt(4. * this->m_proj_parm.z02 * z2 - t * t);
95                     if ((this->m_proj_parm.ccs * sp - cp * (this->m_proj_parm.cs * sin(dl1) - this->m_proj_parm.sc * sin(dl2))) < 0.)
96                         xy_y = -xy_y;
97                 }
98 
99                 // INVERSE(s_inverse)  sphere
100                 // Project coordinates from cartesian (x, y) to geographic (lon, lat)
invboost::geometry::projections::detail::tpeqd::base_tpeqd_spheroid101                 inline void inv(T const& xy_x, T const& xy_y, T& lp_lon, T& lp_lat) const
102                 {
103                     T cz1, cz2, s, d, cp, sp;
104 
105                     cz1 = cos(boost::math::hypot(xy_y, xy_x + this->m_proj_parm.hz0));
106                     cz2 = cos(boost::math::hypot(xy_y, xy_x - this->m_proj_parm.hz0));
107                     s = cz1 + cz2;
108                     d = cz1 - cz2;
109                     lp_lon = - atan2(d, (s * this->m_proj_parm.thz0));
110                     lp_lat = aacos(boost::math::hypot(this->m_proj_parm.thz0 * s, d) * this->m_proj_parm.rhshz0);
111                     if ( xy_y < 0. )
112                         lp_lat = - lp_lat;
113                     /* lam--phi now in system relative to P1--P2 base equator */
114                     sp = sin(lp_lat);
115                     cp = cos(lp_lat);
116                     lp_lat = aasin(this->m_proj_parm.sa * sp + this->m_proj_parm.ca * cp * (s = cos(lp_lon -= this->m_proj_parm.lp)));
117                     lp_lon = atan2(cp * sin(lp_lon), this->m_proj_parm.sa * cp * s - this->m_proj_parm.ca * sp) + this->m_proj_parm.lamc;
118                 }
119 
get_nameboost::geometry::projections::detail::tpeqd::base_tpeqd_spheroid120                 static inline std::string get_name()
121                 {
122                     return "tpeqd_spheroid";
123                 }
124 
125             };
126 
127             // Two Point Equidistant
128             template <typename Params, typename Parameters, typename T>
setup_tpeqd(Params const & params,Parameters & par,par_tpeqd<T> & proj_parm)129             inline void setup_tpeqd(Params const& params, Parameters& par, par_tpeqd<T>& proj_parm)
130             {
131                 T lam_1, lam_2, phi_1, phi_2, A12, pp;
132 
133                 /* get control point locations */
134                 phi_1 = pj_get_param_r<T, srs::spar::lat_1>(params, "lat_1", srs::dpar::lat_1);
135                 lam_1 = pj_get_param_r<T, srs::spar::lon_1>(params, "lon_1", srs::dpar::lon_1);
136                 phi_2 = pj_get_param_r<T, srs::spar::lat_2>(params, "lat_2", srs::dpar::lat_2);
137                 lam_2 = pj_get_param_r<T, srs::spar::lon_2>(params, "lon_2", srs::dpar::lon_2);
138 
139                 if (phi_1 == phi_2 && lam_1 == lam_2)
140                     BOOST_THROW_EXCEPTION( projection_exception(error_control_point_no_dist) );
141 
142                 par.lam0 = adjlon(0.5 * (lam_1 + lam_2));
143                 proj_parm.dlam2 = adjlon(lam_2 - lam_1);
144 
145                 proj_parm.cp1 = cos(phi_1);
146                 proj_parm.cp2 = cos(phi_2);
147                 proj_parm.sp1 = sin(phi_1);
148                 proj_parm.sp2 = sin(phi_2);
149                 proj_parm.cs = proj_parm.cp1 * proj_parm.sp2;
150                 proj_parm.sc = proj_parm.sp1 * proj_parm.cp2;
151                 proj_parm.ccs = proj_parm.cp1 * proj_parm.cp2 * sin(proj_parm.dlam2);
152                 proj_parm.z02 = aacos(proj_parm.sp1 * proj_parm.sp2 + proj_parm.cp1 * proj_parm.cp2 * cos(proj_parm.dlam2));
153                 proj_parm.hz0 = .5 * proj_parm.z02;
154                 A12 = atan2(proj_parm.cp2 * sin(proj_parm.dlam2),
155                     proj_parm.cp1 * proj_parm.sp2 - proj_parm.sp1 * proj_parm.cp2 * cos(proj_parm.dlam2));
156                 proj_parm.ca = cos(pp = aasin(proj_parm.cp1 * sin(A12)));
157                 proj_parm.sa = sin(pp);
158                 proj_parm.lp = adjlon(atan2(proj_parm.cp1 * cos(A12), proj_parm.sp1) - proj_parm.hz0);
159                 proj_parm.dlam2 *= .5;
160                 proj_parm.lamc = geometry::math::half_pi<T>() - atan2(sin(A12) * proj_parm.sp1, cos(A12)) - proj_parm.dlam2;
161                 proj_parm.thz0 = tan(proj_parm.hz0);
162                 proj_parm.rhshz0 = .5 / sin(proj_parm.hz0);
163                 proj_parm.r2z0 = 0.5 / proj_parm.z02;
164                 proj_parm.z02 *= proj_parm.z02;
165 
166                 par.es = 0.;
167             }
168 
169     }} // namespace detail::tpeqd
170     #endif // doxygen
171 
172     /*!
173         \brief Two Point Equidistant projection
174         \ingroup projections
175         \tparam Geographic latlong point type
176         \tparam Cartesian xy point type
177         \tparam Parameters parameter type
178         \par Projection characteristics
179          - Miscellaneous
180          - Spheroid
181         \par Projection parameters
182          - lat_1: Latitude of first standard parallel (degrees)
183          - lon_1 (degrees)
184          - lat_2: Latitude of second standard parallel (degrees)
185          - lon_2 (degrees)
186         \par Example
187         \image html ex_tpeqd.gif
188     */
189     template <typename T, typename Parameters>
190     struct tpeqd_spheroid : public detail::tpeqd::base_tpeqd_spheroid<T, Parameters>
191     {
192         template <typename Params>
tpeqd_spheroidboost::geometry::projections::tpeqd_spheroid193         inline tpeqd_spheroid(Params const& params, Parameters const& par)
194             : detail::tpeqd::base_tpeqd_spheroid<T, Parameters>(par)
195         {
196             detail::tpeqd::setup_tpeqd(params, this->m_par, this->m_proj_parm);
197         }
198     };
199 
200     #ifndef DOXYGEN_NO_DETAIL
201     namespace detail
202     {
203 
204         // Static projection
BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION(srs::spar::proj_tpeqd,tpeqd_spheroid,tpeqd_spheroid)205         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION(srs::spar::proj_tpeqd, tpeqd_spheroid, tpeqd_spheroid)
206 
207         // Factory entry(s)
208         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_ENTRY_FI(tpeqd_entry, tpeqd_spheroid)
209 
210         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_BEGIN(tpeqd_init)
211         {
212             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(tpeqd, tpeqd_entry)
213         }
214 
215     } // namespace detail
216     #endif // doxygen
217 
218 } // namespace projections
219 
220 }} // namespace boost::geometry
221 
222 #endif // BOOST_GEOMETRY_PROJECTIONS_TPEQD_HPP
223 
224