# Coverage for pygeodesy/webmercator.py : 98%

## 118 statements 116 run 2 missing 12 excluded

Hot-keys on this page

r m x p toggle line displays

j k next/prev highlighted chunk

0 (zero) top of page

1 (one) first highlighted chunk

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 | # -*- coding: utf-8 -*- u'''Web Mercator (WM) projection. Classes L{Wm} and L{WebMercatorError} and functions L{parseWM} and L{toWm}. Pure Python implementation of a U{Web Mercator<https://WikiPedia.org/wiki/Web_Mercator>} (aka I{Pseudo-Mercator}) class and conversion functions for spherical and near-spherical earth models. References U{Google Maps / Bing Maps Spherical Mercator Projection <https://AlastairA.WordPress.com/2011/01/23/the-google-maps-bing-maps-spherical-mercator-projection>}, U{Geomatics Guidance Note 7, part 2<https://www.IOGP.org/wp-content/uploads/2019/09/373-07-02.pdf>} and U{Implementation Practice Web Mercator Map Projection <https://Earth-Info.NGA.mil/GandG/wgs84/web_mercator/%28U%29%20NGA_SIG_0011_1.0.0_WEBMERC.pdf>}. ''' from pygeodesy.basics import isscalar, issubclassof from pygeodesy.constants import PI_2, R_M, R_MA, R_MB from pygeodesy.datums import _ALL_LAZY, _ellipsoidal_datum from pygeodesy.dms import clipDegrees, parseDMS2 from pygeodesy.ellipsoidalBase import LatLonEllipsoidalBase as _LLEB from pygeodesy.errors import _IsnotError, _parseX, _TypeError, \ _ValueError, _xkwds from pygeodesy.interns import NN, _COMMASPACE_, _easting_, \ _ellipsoidal_, _northing_, _radius_, \ _SPACE_, _splituple from pygeodesy.interns import _x_, _y_ # PYCHOK used! # from pygeodesy.lazily import _ALL_LAZY from .datums from pygeodesy.named import _NamedBase, _NamedTuple from pygeodesy.namedTuples import LatLon2Tuple, PhiLam2Tuple from pygeodesy.props import deprecated_method, Property_RO from pygeodesy.streprs import Fmt, strs, _xzipairs from pygeodesy.units import Easting, Lam_, Lat, Lon, Northing, Phi_, \ Radius, Radius_ from pygeodesy.utily import degrees90, degrees180 from math import atan, atanh, exp, radians, sin, tanh __all__ = _ALL_LAZY.webmercator __version__ = '22.09.12' # _FalseEasting = 0 # false Easting (C{meter}) # _FalseNorthing = 0 # false Northing (C{meter}) _LatLimit = Lat(limit=85.051129) # latitudinal limit (C{degrees}) # _LonOrigin = 0 # longitude of natural origin (C{degrees}) class EasNorRadius3Tuple(_NamedTuple): '''3-Tuple C{(easting, northing, radius)}, all in C{meter}. ''' _Names_ = (_easting_, _northing_, _radius_) _Units_ = ( Easting, Northing, Radius) class WebMercatorError(_ValueError): '''Web Mercator (WM) parser or L{Wm} issue. ''' pass class Wm(_NamedBase): '''Web Mercator (WM) coordinate. ''' _radius = R_MA # earth radius (C{meter}) _x = 0 # Easting (C{meter}) _y = 0 # Northing (C{meter}) def __init__(self, x, y, radius=R_MA, name=NN): '''New L{Wm} Web Mercator (WM) coordinate. @arg x: Easting from central meridian (C{meter}). @arg y: Northing from equator (C{meter}). @kwarg radius: Optional earth radius (C{meter}). @kwarg name: Optional name (C{str}). @raise WebMercatorError: Invalid B{C{x}}, B{C{y}} or B{C{radius}}. @example: >>> import pygeodesy >>> w = pygeodesy.Wm(448251, 5411932) ''' self._x = Easting( x=x, Error=WebMercatorError) self._y = Northing(y=y, Error=WebMercatorError) if radius != R_MA: self._radius = Radius_(radius, Error=WebMercatorError) if name: self.name = name @Property_RO def latlon(self): '''Get the lat- and longitude (L{LatLon2Tuple}C{(lat, lon)}). ''' return self.latlon2() def latlon2(self, datum=None): '''Convert this WM coordinate to a lat- and longitude. @kwarg datum: Optional, ellipsoidal datum (L{Datum}, L{Ellipsoid}, L{Ellipsoid2} or L{a_f2Tuple}) or C{None}. @return: A L{LatLon2Tuple}C{(lat, lon)}. @raise TypeError: Invalid or non-ellipsoidal B{C{datum}}. @see: Method C{toLatLon}. ''' r = self.radius x = self.x / r y = 2 * atan(exp(self.y / r)) - PI_2 if datum is not None: E = _ellipsoidal_datum(datum, name=self.name).ellipsoid if not E.isEllipsoidal: raise _IsnotError(_ellipsoidal_, datum=datum) # <https://Earth-Info.NGA.mil/GandG/wgs84/web_mercator/ # %28U%29%20NGA_SIG_0011_1.0.0_WEBMERC.pdf> y = y / r if E.e: y -= E.e * atanh(E.e * tanh(y)) # == E.es_atanh(tanh(y)) y *= E.a x *= E.a / r return LatLon2Tuple(Lat(degrees90( y)), Lon(degrees180(x)), name=self.name) def parse(self, strWM, name=NN): '''Parse a string to a similar L{Wm} instance. @arg strWM: The WM coordinate (C{str}), see function L{parseWM}. @kwarg name: Optional instance name (C{str}), overriding this name. @return: The similar instance (L{Wm}). @raise WebMercatorError: Invalid B{C{strWM}}. ''' return parseWM(strWM, radius=self.radius, Wm=self.classof, name=name or self.name) @deprecated_method def parseWM(self, strWM, name=NN): # PYCHOK no cover '''DEPRECATED, use method L{Wm.parse}.''' return self.parse(strWM, name=name) @Property_RO def philam(self): '''Get the lat- and longitude ((L{PhiLam2Tuple}C{(phi, lam)}). ''' r = self.latlon return PhiLam2Tuple(Phi_(r.lat), Lam_(r.lon), name=r.name) @Property_RO def radius(self): '''Get the earth radius (C{meter}). ''' return self._radius @deprecated_method def to2ll(self, datum=None): # PYCHOK no cover '''DEPRECATED, use method C{latlon2}. @return: A L{LatLon2Tuple}C{(lat, lon)}. ''' return self.latlon2(datum=datum) def toLatLon(self, LatLon, datum=None, **LatLon_kwds): '''Convert this WM coordinate to a geodetic point. @arg LatLon: Ellipsoidal class to return the geodetic point (C{LatLon}). @kwarg datum: Optional datum for ellipsoidal or C{None} for spherical B{C{LatLon}} (C{Datum}). @kwarg LatLon_kwds: Optional, additional B{C{LatLon}} keyword arguments. @return: Point of this WM coordinate (B{C{LatLon}}). @raise TypeError: If B{C{LatLon}} and B{C{datum}} are incompatible or if B{C{datum}} is invalid or not ellipsoidal. @example: >>> w = Wm(448251.795, 5411932.678) >>> from pygeodesy import sphericalTrigonometry as sT >>> ll = w.toLatLon(sT.LatLon) # 43°39′11.58″N, 004°01′36.17″E ''' e = issubclassof(LatLon, _LLEB) if e and datum: kwds = _xkwds(LatLon_kwds, datum=datum) elif not (e or datum): # and LatLon kwds = LatLon_kwds datum = None else: raise _TypeError(LatLon=LatLon, datum=datum) r = self.latlon2(datum=datum) return LatLon(r.lat, r.lon, **_xkwds(kwds, name=r.name)) def toRepr(self, prec=3, fmt=Fmt.SQUARE, sep=_COMMASPACE_, radius=False, **unused): # PYCHOK expected '''Return a string representation of this WM coordinate. @kwarg prec: Number of (decimal) digits, unstripped (C{int}). @kwarg fmt: Enclosing backets format (C{str}). @kwarg sep: Optional separator between name:value pairs (C{str}). @kwarg radius: If C{True} include the radius (C{bool}) or C{scalar} to override this WM's radius. @return: This WM as "[x:meter, y:meter]" (C{str}) plus ", radius:meter]" if B{C{radius}} is C{True} or C{scalar}. @raise WebMercatorError: Invalid B{C{radius}}. ''' t = self.toStr(prec=prec, sep=None, radius=radius) n = (_x_, _y_, _radius_)[:len(t)] return _xzipairs(n, t, sep=sep, fmt=fmt) def toStr(self, prec=3, fmt=Fmt.F, sep=_SPACE_, radius=False, **unused): # PYCHOK expected '''Return a string representation of this WM coordinate. @kwarg prec: Number of (decimal) digits, unstripped (C{int}). @kwarg fmt: The C{float} format (C{str}). @kwarg sep: Optional separator to join (C{str}) or C{None} to return an unjoined C{tuple} of C{str}s. @kwarg radius: If C{True} include the radius (C{bool}) or C{scalar} to override this WM's radius. @return: This WM as "meter meter" (C{str}) or as "meter meter radius" if B{C{radius}} is C{True} or C{scalar}. @raise WebMercatorError: Invalid B{C{radius}}. @example: >>> w = Wm(448251, 5411932.0001) >>> w.toStr(4) # 448251.0 5411932.0001 >>> w.toStr(sep=', ') # 448251, 5411932 ''' fs = self.x, self.y if isscalar(radius): fs += (radius,) elif radius: # is True: fs += (self.radius,) elif radius not in (None, False): raise WebMercatorError(radius=radius) t = strs(fs, prec=prec) return t if sep is None else sep.join(t) @Property_RO def x(self): '''Get the easting (C{meter}). ''' return self._x @Property_RO def y(self): '''Get the northing (C{meter}). ''' return self._y def parseWM(strWM, radius=R_MA, Wm=Wm, name=NN): '''Parse a string C{"e n [r]"} representing a WM coordinate, consisting of easting, northing and an optional radius. @arg strWM: A WM coordinate (C{str}). @kwarg radius: Optional earth radius (C{meter}). @kwarg Wm: Optional class to return the WM coordinate (L{Wm}) or C{None}. @kwarg name: Optional name (C{str}). @return: The WM coordinate (B{C{Wm}}) or an L{EasNorRadius3Tuple}C{(easting, northing, radius)} if B{C{Wm}} is C{None}. @raise WebMercatorError: Invalid B{C{strWM}}. @example: >>> u = parseWM('448251 5411932') >>> u.toRepr() # [E:448251, N:5411932] ''' def _WM(strWM, radius, Wm, name): w = _splituple(strWM) if len(w) == 2: w += (radius,) elif len(w) != 3: raise ValueError x, y, r = map(float, w) return EasNorRadius3Tuple(x, y, r, name=name) if Wm is None else \ Wm(x, y, radius=r, name=name) return _parseX(_WM, strWM, radius, Wm, name, strWM=strWM, Error=WebMercatorError) def toWm(latlon, lon=None, radius=R_MA, Wm=Wm, name=NN, **Wm_kwds): '''Convert a lat-/longitude point to a WM coordinate. @arg latlon: Latitude (C{degrees}) or an (ellipsoidal or spherical) geodetic C{LatLon} point. @kwarg lon: Optional longitude (C{degrees} or C{None}). @kwarg radius: Optional earth radius (C{meter}), overridden by the B{C{latlon}}'s equatorial radius. @kwarg Wm: Optional class to return the WM coordinate (L{Wm}) or C{None}. @kwarg name: Optional name (C{str}). @kwarg Wm_kwds: Optional, additional B{C{Wm}} keyword arguments, ignored if C{B{Wm} is None}. @return: The WM coordinate (B{C{Wm}}) or if B{C{Wm}} is C{None} an L{EasNorRadius3Tuple}C{(easting, northing, radius)}. @raise ValueError: If B{C{lon}} value is missing, if B{C{latlon}} is not scalar, if B{C{latlon}} is beyond the valid WM range and L{pygeodesy.rangerrors} is set to C{True} or if B{C{radius}} is invalid. @example: >>> p = LatLon(48.8582, 2.2945) # 448251.8 5411932.7 >>> w = toWm(p) # 448252 5411933 >>> p = LatLon(13.4125, 103.8667) # 377302.4 1483034.8 >>> w = toWm(p) # 377302 1483035 ''' e, r, n = 0, radius, name if r not in (R_MA, R_MB, R_M): r = Radius(radius) try: y, x = latlon.lat, latlon.lon if isinstance(latlon, _LLEB): E = latlon.datum.ellipsoid e, r = E.e, E.a y = clipDegrees(y, _LatLimit) n = name or latlon.name except AttributeError: y, x = parseDMS2(latlon, lon, clipLat=_LatLimit) s = sin(radians(y)) y = atanh(s) # == log(tan((90 + lat) / 2)) == log(tanPI_2_2(radians(lat))) if e: y -= e * atanh(e * s) y *= r x = r * radians(x) r = EasNorRadius3Tuple(x, y, r, name=n) if Wm is None else \ Wm(x, y, **_xkwds(Wm_kwds, radius=r, name=n)) return r # **) MIT License # # Copyright (C) 2016-2023 -- mrJean1 at Gmail -- All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the "Software"), # to deal in the Software without restriction, including without limitation # the rights to use, copy, modify, merge, publish, distribute, sublicense, # and/or sell copies of the Software, and to permit persons to whom the # Software is furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR # OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR # OTHER DEALINGS IN THE SOFTWARE.