Imported Upstream version 1.72.0
[platform/upstream/boost.git] / boost / geometry / srs / projections / proj / urm5.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_URM5_HPP
41 #define BOOST_GEOMETRY_PROJECTIONS_URM5_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 namespace boost { namespace geometry
51 {
52
53 namespace projections
54 {
55     #ifndef DOXYGEN_NO_DETAIL
56     namespace detail { namespace urm5
57     {
58             template <typename T>
59             struct par_urm5
60             {
61                 T m, rmn, q3, n;
62             };
63
64             template <typename T, typename Parameters>
65             struct base_urm5_spheroid
66             {
67                 par_urm5<T> m_proj_parm;
68
69                 // FORWARD(s_forward)  spheroid
70                 // Project coordinates from geographic (lon, lat) to cartesian (x, y)
71                 inline void fwd(Parameters const&, T const& lp_lon, T lp_lat, T& xy_x, T& xy_y) const
72                 {
73                     T t;
74
75                     t = lp_lat = aasin(this->m_proj_parm.n * sin(lp_lat));
76                     xy_x = this->m_proj_parm.m * lp_lon * cos(lp_lat);
77                     t *= t;
78                     xy_y = lp_lat * (1. + t * this->m_proj_parm.q3) * this->m_proj_parm.rmn;
79                 }
80
81                 static inline std::string get_name()
82                 {
83                     return "urm5_spheroid";
84                 }
85
86             };
87
88             // Urmaev V
89             template <typename Params, typename Parameters, typename T>
90             inline void setup_urm5(Params const& params, Parameters& par, par_urm5<T>& proj_parm)
91             {
92                 T alpha, t;
93
94                 if (pj_param_f<srs::spar::n>(params, "n", srs::dpar::n, proj_parm.n)) {
95                     if (proj_parm.n <= 0. || proj_parm.n > 1.)
96                         BOOST_THROW_EXCEPTION( projection_exception(error_n_out_of_range) );
97                 } else {
98                     BOOST_THROW_EXCEPTION( projection_exception(error_n_out_of_range) );
99                 }
100                 proj_parm.q3 = pj_get_param_f<T, srs::spar::q>(params, "q", srs::dpar::q) / 3.;
101                 alpha = pj_get_param_r<T, srs::spar::alpha>(params, "alpha", srs::dpar::alpha);
102                 t = proj_parm.n * sin(alpha);
103                 proj_parm.m = cos(alpha) / sqrt(1. - t * t);
104                 proj_parm.rmn = 1. / (proj_parm.m * proj_parm.n);
105
106                 par.es = 0.;
107             }
108
109     }} // namespace detail::urm5
110     #endif // doxygen
111
112     /*!
113         \brief Urmaev V 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          - Spheroid
121          - no inverse
122         \par Projection parameters
123          - n (real)
124          - q (real)
125          - alpha: Alpha (degrees)
126         \par Example
127         \image html ex_urm5.gif
128     */
129     template <typename T, typename Parameters>
130     struct urm5_spheroid : public detail::urm5::base_urm5_spheroid<T, Parameters>
131     {
132         template <typename Params>
133         inline urm5_spheroid(Params const& params, Parameters & par)
134         {
135             detail::urm5::setup_urm5(params, par, this->m_proj_parm);
136         }
137     };
138
139     #ifndef DOXYGEN_NO_DETAIL
140     namespace detail
141     {
142
143         // Static projection
144         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION_F(srs::spar::proj_urm5, urm5_spheroid)
145
146         // Factory entry(s)
147         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_ENTRY_F(urm5_entry, urm5_spheroid)
148         
149         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_BEGIN(urm5_init)
150         {
151             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(urm5, urm5_entry)
152         }
153
154     } // namespace detail
155     #endif // doxygen
156
157 } // namespace projections
158
159 }} // namespace boost::geometry
160
161 #endif // BOOST_GEOMETRY_PROJECTIONS_URM5_HPP
162