Imported Upstream version 1.72.0
[platform/upstream/boost.git] / boost / geometry / srs / projections / proj / eqc.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_EQC_HPP
41 #define BOOST_GEOMETRY_PROJECTIONS_EQC_HPP
42
43 #include <boost/geometry/srs/projections/impl/base_static.hpp>
44 #include <boost/geometry/srs/projections/impl/base_dynamic.hpp>
45 #include <boost/geometry/srs/projections/impl/factory_entry.hpp>
46 #include <boost/geometry/srs/projections/impl/pj_param.hpp>
47 #include <boost/geometry/srs/projections/impl/projects.hpp>
48
49 namespace boost { namespace geometry
50 {
51
52 namespace projections
53 {
54     #ifndef DOXYGEN_NO_DETAIL
55     namespace detail { namespace eqc
56     {
57             template <typename T>
58             struct par_eqc
59             {
60                 T rc;
61             };
62
63             template <typename T, typename Parameters>
64             struct base_eqc_spheroid
65             {
66                 par_eqc<T> m_proj_parm;
67
68                 // FORWARD(s_forward)  spheroid
69                 // Project coordinates from geographic (lon, lat) to cartesian (x, y)
70                 inline void fwd(Parameters const& par, T const& lp_lon, T const& lp_lat, T& xy_x, T& xy_y) const
71                 {
72                     xy_x = this->m_proj_parm.rc * lp_lon;
73                     xy_y = lp_lat - par.phi0;
74                 }
75
76                 // INVERSE(s_inverse)  spheroid
77                 // Project coordinates from cartesian (x, y) to geographic (lon, lat)
78                 inline void inv(Parameters const& par, T const& xy_x, T const& xy_y, T& lp_lon, T& lp_lat) const
79                 {
80                     lp_lon = xy_x / this->m_proj_parm.rc;
81                     lp_lat = xy_y + par.phi0;
82                 }
83
84                 static inline std::string get_name()
85                 {
86                     return "eqc_spheroid";
87                 }
88
89             };
90
91             // Equidistant Cylindrical (Plate Caree)
92             template <typename Params, typename Parameters, typename T>
93             inline void setup_eqc(Params const& params, Parameters& par, par_eqc<T>& proj_parm)
94             {
95                 proj_parm.rc = cos(pj_get_param_r<T, srs::spar::lat_ts>(params, "lat_ts", srs::dpar::lat_ts));
96                 if (proj_parm.rc <= 0.)
97                     BOOST_THROW_EXCEPTION( projection_exception(error_lat_ts_larger_than_90) );
98                 par.es = 0.;
99             }
100
101     }} // namespace detail::eqc
102     #endif // doxygen
103
104     /*!
105         \brief Equidistant Cylindrical (Plate Caree) projection
106         \ingroup projections
107         \tparam Geographic latlong point type
108         \tparam Cartesian xy point type
109         \tparam Parameters parameter type
110         \par Projection characteristics
111          - Cylindrical
112          - Spheroid
113         \par Projection parameters
114          - lat_ts: Latitude of true scale (degrees)
115          - lat_0: Latitude of origin
116         \par Example
117         \image html ex_eqc.gif
118     */
119     template <typename T, typename Parameters>
120     struct eqc_spheroid : public detail::eqc::base_eqc_spheroid<T, Parameters>
121     {
122         template <typename Params>
123         inline eqc_spheroid(Params const& params, Parameters & par)
124         {
125             detail::eqc::setup_eqc(params, par, this->m_proj_parm);
126         }
127     };
128
129     #ifndef DOXYGEN_NO_DETAIL
130     namespace detail
131     {
132
133         // Static projection
134         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION_FI(srs::spar::proj_eqc, eqc_spheroid)
135
136         // Factory entry(s)
137         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_ENTRY_FI(eqc_entry, eqc_spheroid)
138         
139         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_BEGIN(eqc_init)
140         {
141             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(eqc, eqc_entry);
142         }
143
144     } // namespace detail
145     #endif // doxygen
146
147 } // namespace projections
148
149 }} // namespace boost::geometry
150
151 #endif // BOOST_GEOMETRY_PROJECTIONS_EQC_HPP
152