# Coverage for pygeodesy/ellipsoidalVincenty.py : 98%

## 169 statements 166 run 3 missing 16 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 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 | # -*- coding: utf-8 -*- u'''Ellipsoidal, I{Vincenty}-based geodesy. I{Thaddeus Vincenty}'s geodetic (lat-/longitude) L{LatLon}, geocentric (ECEF) L{Cartesian} and L{VincentyError} classes and functions L{areaOf}, L{intersections2}, L{nearestOn} and L{perimeterOf}. Pure Python implementation of geodesy tools for ellipsoidal earth models, transcoded from JavaScript originals by I{(C) Chris Veness 2005-2016} and published under the same MIT Licence**, see U{Vincenty geodesics <https://www.Movable-Type.co.UK/scripts/LatLongVincenty.html>}. More at U{geographiclib<https://PyPI.org/project/geographiclib>} and U{GeoPy<https://PyPI.org/project/geopy>}. Calculate geodesic distance between two points using the U{Vincenty <https://WikiPedia.org/wiki/Vincenty's_formulae>} formulae and one of several ellipsoidal earth models. The default model is WGS-84, the most accurate and widely used globally-applicable model for the earth ellipsoid. Other ellipsoids offering a better fit to the local geoid include Airy (1830) in the UK, Clarke (1880) in Africa, International 1924 in much of Europe, and GRS-67 in South America. North America (NAD83) and Australia (GDA) use GRS-80, which is equivalent to the WGS-84 model. Great-circle distance uses a spherical model of the earth with the mean earth radius defined by the International Union of Geodesy and Geophysics (IUGG) as M{(2 * a + b) / 3 = 6371008.7714150598} meter or approx. 6371009 meter (for WGS-84, resulting in an error of up to about 0.5%). Here's an example usage of C{ellipsoidalVincenty}: >>> from pygeodesy.ellipsoidalVincenty import LatLon >>> Newport_RI = LatLon(41.49008, -71.312796) >>> Cleveland_OH = LatLon(41.499498, -81.695391) >>> Newport_RI.distanceTo(Cleveland_OH) 866,455.4329158525 # meter To change the ellipsoid model used by the Vincenty formulae use: >>> from pygeodesy import Datums >>> from pygeodesy.ellipsoidalVincenty import LatLon >>> p = LatLon(0, 0, datum=Datums.OSGB36) or by converting to anothor datum: >>> p = p.toDatum(Datums.OSGB36) ''' # make sure int/int division yields float quotient, see .basics from __future__ import division as _; del _ # PYCHOK semicolon # from pygeodesy.basics import isnear0 # from .fmath from pygeodesy.constants import EPS, _0_0, _1_0, _2_0, _3_0, _4_0, _6_0, _16_0 # from pygeodesy.datums import _WGS84 # from .ellipsoidalBase from pygeodesy.ellipsoidalBase import CartesianEllipsoidalBase, _nearestOn, _WGS84 from pygeodesy.ellipsoidalBaseDI import _intersection3, _intersections2, \ LatLonEllipsoidalBaseDI, _TOL_M from pygeodesy.errors import _and, _ValueError, _xkwds from pygeodesy.fmath import Fpolynomial, hypot, hypot1, isnear0 from pygeodesy.interns import _ambiguous_, _antipodal_, _COLONSPACE_, _to_, _SPACE_ from pygeodesy.lazily import _ALL_DOCS, _ALL_LAZY, _ALL_MODS as _MODS, _ALL_OTHER from pygeodesy.namedTuples import Destination2Tuple, Destination3Tuple, \ Distance3Tuple from pygeodesy.points import Fmt, ispolar # PYCHOK exported from pygeodesy.props import deprecated_function, deprecated_method, \ Property_RO, property_doc_ # from pygeodesy.streprs import Fmt # from .points from pygeodesy.units import Number_, Scalar_ from pygeodesy.utily import atan2b, atan2d, sincos2, unroll180, wrap180 from math import atan2, cos, degrees, radians, tan __all__ = _ALL_LAZY.ellipsoidalVincenty __version__ = '22.09.12' _antipodal_to_ = _SPACE_(_antipodal_, _to_) _limit_ = 'limit' # PYCHOK used! class VincentyError(_ValueError): '''Error raised from I{Vincenty}'s C{direct} and C{inverse} methods for coincident points or lack of convergence. ''' pass class Cartesian(CartesianEllipsoidalBase): '''Extended to convert geocentric, L{Cartesian} points to Vincenty-based, ellipsoidal, geodetic L{LatLon}. ''' @Property_RO def Ecef(self): '''Get the ECEF I{class} (L{EcefVeness}), I{lazily}. ''' return _MODS.ecef.EcefVeness def toLatLon(self, **LatLon_and_kwds): # PYCHOK LatLon=LatLon, datum=None '''Convert this cartesian point to a C{Vincenty}-based geodetic point. @kwarg LatLon_and_kwds: Optional L{LatLon} and L{LatLon} keyword arguments as C{datum}. Use C{B{LatLon}=..., B{datum}=...} to override this L{LatLon} class or specify C{B{LatLon}=None}. @return: The geodetic point (L{LatLon}) or if B{C{LatLon}} is C{None}, an L{Ecef9Tuple}C{(x, y, z, lat, lon, height, C, M, datum)} with C{C} and C{M} if available. @raise TypeError: Invalid B{C{LatLon_and_kwds}} argument. ''' kwds = _xkwds(LatLon_and_kwds, LatLon=LatLon, datum=self.datum) return CartesianEllipsoidalBase.toLatLon(self, **kwds) class LatLon(LatLonEllipsoidalBaseDI): '''Using the formulae devised by U{I{Thaddeus Vincenty (1975)} <https://WikiPedia.org/wiki/Vincenty's_formulae>} for an (oblate) ellipsoidal model of the earth to compute the geodesic distance and bearings between two given points or the destination point given an start point and (initial) bearing. Set the earth model to be used with the keyword argument datum. The default is Datums.WGS84, which is the most globally accurate. For other models, see the Datums in module datum. Note: This implementation of I{Vincenty} methods may not converge for some valid points, raising a L{VincentyError}. In that case, a result may be obtained by increasing the tolerance C{epsilon} and/or iteration C{limit}, see properties L{LatLon.epsilon} and L{LatLon.iterations}. ''' _epsilon = 1e-12 # radians, about 6 um # _iteration = None # iteration number from .named._NamedBase _iterations = 101 # default max, 100 vs Veness' 500 @deprecated_method def bearingTo(self, other, wrap=False): # PYCHOK no cover '''DEPRECATED, use method L{initialBearingTo} or L{bearingTo2}. ''' return self.initialBearingTo(other, wrap=wrap) @Property_RO def Ecef(self): '''Get the ECEF I{class} (L{EcefVeness}), I{lazily}. ''' return _MODS.ecef.EcefVeness @property_doc_(''' the convergence epsilon (C{radians}).''') def epsilon(self): '''Get the convergence epsilon (C{radians}). ''' return self._epsilon @epsilon.setter # PYCHOK setter! def epsilon(self, epsilon): '''Set the convergence epsilon (C{radians}). @raise TypeError: Non-scalar B{C{epsilon}}. @raise ValueError: Out of bounds B{C{epsilon}}. ''' self._epsilon = Scalar_(epsilon=epsilon) @property_doc_(''' the iteration limit (C{int}).''') def iterations(self): '''Get the iteration limit (C{int}). ''' return self._iterations - 1 @iterations.setter # PYCHOK setter! def iterations(self, limit): '''Set the iteration limit (C{int}). @raise TypeError: Non-scalar B{C{limit}}. @raise ValueError: Out-of-bounds B{C{limit}}. ''' self._iterations = Number_(limit, name=_limit_, low=4, high=500) + 1 def toCartesian(self, **Cartesian_datum_kwds): # PYCHOK Cartesian=Cartesian, datum=None '''Convert this point to C{Vincenty}-based cartesian (ECEF) coordinates. @kwarg Cartesian_datum_kwds: Optional L{Cartesian}, B{C{datum}} and other keyword arguments, ignored if C{B{Cartesian} is None}. Use C{B{Cartesian}=...} to override this L{Cartesian} class or specify C{B{Cartesian} is None}. @return: The cartesian point (L{Cartesian}) or if B{C{Cartesian}} is C{None}, an L{Ecef9Tuple}C{(x, y, z, lat, lon, height, C, M, datum)} with C{C} and C{M} if available. @raise TypeError: Invalid B{C{Cartesian}}, B{C{datum}} or other B{C{Cartesian_datum_kwds}}. ''' kwds = _xkwds(Cartesian_datum_kwds, Cartesian=Cartesian, datum=self.datum) return LatLonEllipsoidalBaseDI.toCartesian(self, **kwds) def _Direct(self, distance, bearing, llr, height): '''(INTERNAL) Direct Vincenty method. @raise TypeError: The B{C{other}} point is not L{LatLon}. @raise ValueError: If this and the B{C{other}} point's L{Datum} ellipsoids are not compatible. @raise VincentyError: Vincenty fails to converge for the current L{LatLon.epsilon} and L{LatLon.iterations} limits. ''' E = self.ellipsoid() f = E.f s1, c1, t1 = _rsct3(self.phi, f) i = radians(bearing) # initial bearing (forward azimuth) si, ci = sincos2(i) s12 = atan2(t1, ci) * _2_0 sa = c1 * si ca2 = _1_0 - sa**2 if ca2 < EPS: ca2 = _0_0 A, B = _p2(ca2 * E.e22) # e22 == (a / b)**2 - s = d = distance / (E.b * A) for i in range(1, self._iterations): # 1-origin ss, cs = sincos2(s) c2sm = cos(s12 + s) s_, s = s, _Ds(B, cs, ss, c2sm, d) t = abs(s - s_) if t < self._epsilon: self._iteration = i break else: t = self._no_convergence(t) raise VincentyError(t, txt=repr(self)) # self.toRepr() t = s1 * ss - c1 * cs * ci # final bearing (reverse azimuth +/- 180) r = atan2b(sa, -t) if llr: a = atan2d(s1 * cs + c1 * ss * ci, E.b_a * hypot(sa, t)) b = atan2d(ss * si, c1 * cs - s1 * ss * ci) + self.lon d = degrees(_Dl(f, ca2, sa, s, cs, ss, c2sm)) t = Destination3Tuple(a, wrap180(b - d), r) r = self._Direct2Tuple(self.classof, height, t) else: r = Destination2Tuple(None, r, name=self.name) return r def _Inverse(self, other, wrap, azis=True): # PYCHOK signature '''(INTERNAL) Inverse Vincenty method. @raise TypeError: The B{C{other}} point is not L{LatLon}. @raise ValueError: If this and the B{C{other}} point's L{Datum} ellipsoids are not compatible. @raise VincentyError: Vincenty fails to converge for the current L{LatLon.epsilon} and L{LatLon.iterations} limits and/or if this and the B{C{other}} point are coincident or near-antipodal. ''' E = self.ellipsoids(other) f = E.f s1, c1, _ = _rsct3( self.phi, f) s2, c2, _ = _rsct3(other.phi, f) c1c2, s1c2 = c1 * c2, s1 * c2 c1s2, s1s2 = c1 * s2, s1 * s2 dl, _ = unroll180(self.lon, other.lon, wrap=wrap) ll = dl = radians(dl) for i in range(1, self._iterations): # 1-origin sll, cll = sincos2(ll) ss = hypot(c2 * sll, c1s2 - s1c2 * cll) if ss < EPS: # coincident or antipodal, ... if self.isantipodeTo(other, eps=self.epsilon): t = self._is_to(other, True) raise VincentyError(_ambiguous_, txt=t) self._iteration = i # return zeros like Karney, but unlike Veness return Distance3Tuple(_0_0, 0, 0) cs = s1s2 + c1c2 * cll s = atan2(ss, cs) sa = c1c2 * sll / ss ca2 = _1_0 - sa**2 ll_ = ll ll = dl if isnear0(ca2): ca2 = _0_0 # equatorial line ll += f * sa * s else: c2sm = cs - 2 * s1s2 / ca2 ll += _Dl(f, ca2, sa, s, cs, ss, c2sm) c = abs(ll - ll_) if c < self._epsilon: self._iteration = i break # # omitted and applied only after failure to converge below, see footnote # # under Inverse at <https://WikiPedia.org/wiki/Vincenty's_formulae> # # <https://GitHub.com/ChrisVeness/geodesy/blob/master/latlon-vincenty.js> # elif abs(ll) > PI and self.isantipodeTo(other, eps=self._epsilon): # raise VincentyError(_ambiguous_, self._is_to(other, True)) else: t = self._is_to(other, self.isantipodeTo(other, eps=self.epsilon)) raise VincentyError(self._no_convergence(c), txt=t) if ca2: # e22 == (a / b)**2 - 1 A, B = _p2(ca2 * E.e22) s = -A * _Ds(B, cs, ss, c2sm, -s) b = E.b # if self.height or other.height: # b += self._havg(other) d = b * s if azis: # forward and reverse azimuth s, c = sincos2(ll) f = atan2b(c2 * s, c1s2 - s1c2 * c) r = atan2b(c1 * s, -s1c2 + c1s2 * c) else: f = r = _0_0 return Distance3Tuple(d, f, r, name=self.name) def _is_to(self, other, anti): '''(INTERNAL) Return I{'<self> [antipodal] to <other>'} text (C{str}). ''' t = _antipodal_to_ if anti else _to_ return _SPACE_(repr(self), t, repr(other)) def _no_convergence(self, d): '''(INTERNAL) Return I{'no convergence (..): ...'} text (C{str}). ''' t = (Fmt.PARENSPACED(*t) for t in ((LatLon.epsilon.name, self.epsilon), (LatLon.iterations.name, self.iterations))) return _COLONSPACE_(Fmt.no_convergence(d), _and(*t)) def _c2sm2(c2sm): '''(INTERNAL) C{2 * c2sm**2 - 1}. ''' return _2_0 * c2sm**2 - _1_0 def _Dl(f, ca2, sa, s, cs, ss, c2sm): '''(INTERNAL) C{Dl}. ''' if f and sa: C = f / _16_0 * ca2 * (f * (_4_0 - _3_0 * ca2) + _4_0) return (_1_0 - C) * f * sa * (s + C * ss * (c2sm + C * cs * _c2sm2(c2sm))) return _0_0 def _Ds(B, cs, ss, c2sm, d): '''(INTERNAL) C{Ds - d}. ''' if B and ss: c2sm2 = _c2sm2(c2sm) ss2 = (_4_0 * ss**2 - _3_0) * (c2sm2 * _2_0 - _1_0) B *= ss * (c2sm + B / _4_0 * (c2sm2 * cs - B / _6_0 * c2sm * ss2)) d += B return d def _p2(u2): # e'2 WGS84 = 0.00673949674227643 '''(INTERNAL) Compute A, B polynomials. ''' if u2: A = Fpolynomial(u2, 16384, 4096, -768, 320, -175).fover(16384) B = Fpolynomial(u2, 0, 256, -128, 74, -47).fover( 1024) return A, B return _1_0, _0_0 def _rsct3(a, f): '''(INTERNAL) Reduced C{(sin(B{a}), cos(B{a}), tan(B{a}))}. ''' if a: t = (_1_0 - f) * tan(a) if t: c = _1_0 / hypot1(t) s = t * c return s, c, t return _0_0, _1_0, _0_0 @deprecated_function def areaOf(points, datum=_WGS84, wrap=True): # PYCHOK no cover '''DEPRECATED, use function L{ellipsoidalExact.areaOf} or L{ellipsoidalKarney.areaOf}. ''' try: return _MODS.ellipsoidalKarney.areaOf(points, datum=datum, wrap=wrap) except ImportError: return _MODS.ellipsoidalExact.areaOf(points, datum=datum, wrap=wrap) def intersection3(start1, end1, start2, end2, height=None, wrap=True, equidistant=None, tol=_TOL_M, LatLon=LatLon, **LatLon_kwds): '''Iteratively compute the intersection point of two paths, each defined by two (ellipsoidal) points or by an (ellipsoidal) start point and a bearing from North. @arg start1: Start point of the first path (L{LatLon}). @arg end1: End point of the first path (L{LatLon}) or the initial bearing at the first point (compass C{degrees360}). @arg start2: Start point of the second path (L{LatLon}). @arg end2: End point of the second path (L{LatLon}) or the initial bearing at the second point (compass C{degrees360}). @kwarg height: Optional height at the intersection (C{meter}, conventionally) or C{None} for the mean height. @kwarg wrap: Wrap and unroll longitudes (C{bool}). @kwarg equidistant: An azimuthal equidistant projection (I{class} or function L{pygeodesy.equidistant}) or C{None} for the preferred C{B{start1}.Equidistant}. @kwarg tol: Tolerance for convergence and for skew line distance and length (C{meter}, conventionally). @kwarg LatLon: Optional class to return the intersection points (L{LatLon}) or C{None}. @kwarg LatLon_kwds: Optional, additional B{C{LatLon}} keyword arguments, ignored if C{B{LatLon} is None}. @return: An L{Intersection3Tuple}C{(point, outside1, outside2)} with C{point} a B{C{LatLon}} or if C{B{LatLon} is None}, a L{LatLon4Tuple}C{(lat, lon, height, datum)}. @raise IntersectionError: Skew, colinear, parallel or otherwise non-intersecting paths or no convergence for the given B{C{tol}}. @raise TypeError: Invalid or non-ellipsoidal B{C{start1}}, B{C{end1}}, B{C{start2}} or B{C{end2}} or invalid B{C{equidistant}}. @note: For each path specified with an initial bearing, a pseudo-end point is computed as the C{destination} along that bearing at about 1.5 times the distance from the start point to an initial gu-/estimate of the intersection point (and between 1/8 and 3/8 of the authalic earth perimeter). @see: U{The B{ellipsoidal} case<https://GIS.StackExchange.com/questions/48937/ calculating-intersection-of-two-circles>} and U{Karney's paper <https://ArXiv.org/pdf/1102.1215.pdf>}, pp 20-21, section B{14. MARITIME BOUNDARIES} for more details about the iteration algorithm. ''' return _intersection3(start1, end1, start2, end2, height=height, wrap=wrap, equidistant=equidistant, tol=tol, LatLon=LatLon, **LatLon_kwds) def intersections2(center1, radius1, center2, radius2, height=None, wrap=True, equidistant=None, tol=_TOL_M, LatLon=LatLon, **LatLon_kwds): '''Iteratively compute the intersection points of two circles, each defined by an (ellipsoidal) center point and a radius. @arg center1: Center of the first circle (L{LatLon}). @arg radius1: Radius of the first circle (C{meter}, conventionally). @arg center2: Center of the second circle (L{LatLon}). @arg radius2: Radius of the second circle (C{meter}, same units as B{C{radius1}}). @kwarg height: Optional height for the intersection points (C{meter}, conventionally) or C{None} for the I{"radical height"} at the I{radical line} between both centers. @kwarg wrap: Wrap and unroll longitudes (C{bool}). @kwarg equidistant: An azimuthal equidistant projection (I{class} or function L{pygeodesy.equidistant}) or C{None} for the preferred C{B{center1}.Equidistant}. @kwarg tol: Convergence tolerance (C{meter}, same units as B{C{radius1}} and B{C{radius2}}). @kwarg LatLon: Optional class to return the intersection points (L{LatLon}) or C{None}. @kwarg LatLon_kwds: Optional, additional B{C{LatLon}} keyword arguments, ignored if C{B{LatLon} is None}. @return: 2-Tuple of the intersection points, each a B{C{LatLon}} instance or L{LatLon4Tuple}C{(lat, lon, height, datum)} if C{B{LatLon} is None}. For abutting circles, both points are the same instance, aka the I{radical center}. @raise IntersectionError: Concentric, antipodal, invalid or non-intersecting circles or no convergence for the B{C{tol}}. @raise TypeError: Invalid or non-ellipsoidal B{C{center1}} or B{C{center2}} or invalid B{C{equidistant}}. @raise UnitError: Invalid B{C{radius1}}, B{C{radius2}} or B{C{height}}. @see: U{The B{ellipsoidal} case<https://GIS.StackExchange.com/questions/48937/ calculating-intersection-of-two-circles>}, U{Karney's paper <https://ArXiv.org/pdf/1102.1215.pdf>}, pp 20-21, section B{14. MARITIME BOUNDARIES}, U{circle-circle<https://MathWorld.Wolfram.com/Circle-CircleIntersection.html>} and U{sphere-sphere<https://MathWorld.Wolfram.com/Sphere-SphereIntersection.html>} intersections. ''' return _intersections2(center1, radius1, center2, radius2, height=height, wrap=wrap, equidistant=equidistant, tol=tol, LatLon=LatLon, **LatLon_kwds) def nearestOn(point, point1, point2, within=True, height=None, wrap=False, equidistant=None, tol=_TOL_M, LatLon=LatLon, **LatLon_kwds): '''Iteratively locate the closest point on the geodesic between two other (ellipsoidal) points. @arg point: Reference point (C{LatLon}). @arg point1: Start point of the geodesic (C{LatLon}). @arg point2: End point of the geodesic (C{LatLon}). @kwarg within: If C{True} return the closest point I{between} B{C{point1}} and B{C{point2}}, otherwise the closest point elsewhere on the geodesic (C{bool}). @kwarg height: Optional height for the closest point (C{meter}, conventionally) or C{None} or C{False} for the interpolated height. If C{False}, the closest takes the heights of the points into account. @kwarg wrap: Wrap and unroll longitudes (C{bool}). @kwarg equidistant: An azimuthal equidistant projection (I{class} or function L{pygeodesy.equidistant}) or C{None} for the preferred C{B{point}.Equidistant}. @kwarg tol: Convergence tolerance (C{meter}). @kwarg LatLon: Optional class to return the closest point (L{LatLon}) or C{None}. @kwarg LatLon_kwds: Optional, additional B{C{LatLon}} keyword arguments, ignored if C{B{LatLon} is None}. @return: Closest point, a B{C{LatLon}} instance or if C{B{LatLon} is None}, a L{LatLon4Tuple}C{(lat, lon, height, datum)}. @raise ImportError: Package U{geographiclib <https://PyPI.org/project/geographiclib>} not installed or not found, but only if C{B{equidistant}=}L{EquidistantKarney}. @raise TypeError: Invalid or non-ellipsoidal B{C{point}}, B{C{point1}} or B{C{point2}} or invalid B{C{equidistant}}. @raise ValueError: No convergence for the B{C{tol}}. @see: U{The B{ellipsoidal} case<https://GIS.StackExchange.com/questions/48937/ calculating-intersection-of-two-circles>} and U{Karney's paper <https://ArXiv.org/pdf/1102.1215.pdf>}, pp 20-21, section B{14. MARITIME BOUNDARIES} for more details about the iteration algorithm. ''' return _nearestOn(point, point1, point2, within=within, height=height, wrap=wrap, equidistant=equidistant, tol=tol, LatLon=LatLon, **LatLon_kwds) @deprecated_function def perimeterOf(points, closed=False, datum=_WGS84, wrap=True): # PYCHOK no cover '''DEPRECATED, use function L{ellipsoidalExact.perimeterOf} or L{ellipsoidalKarney.perimeterOf}. ''' return _MODS.ellipsoidalKarney.perimeterOf(points, closed=closed, datum=datum, wrap=wrap) __all__ += _ALL_OTHER(Cartesian, LatLon, intersection3, intersections2, ispolar, # from .points nearestOn) + _ALL_DOCS(areaOf, perimeterOf) # deprecated # **) MIT License # # Copyright (C) 2016-2022 -- 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.