Package pygeodesy :: Module ellipsoidalVincenty :: Class LatLon
[frames] | no frames]

Class LatLon

               object --+                    
                        |                    
             named._Named --+                
                            |                
             named._NamedBase --+            
                                |            
            latlonBase.LatLonBase --+        
                                    |        
ellipsoidalBase.LatLonEllipsoidalBase --+    
                                        |    
ellipsoidalBaseDI.LatLonEllipsoidalBaseDI --+
                                            |
                                           LatLon

Using the formulae devised by Thaddeus Vincenty (1975) 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 Vincenty methods may not converge for some valid points, raising a VincentyError. In that case, a result may be obtained by increasing the tolerance epsilon and/or iteration limit, see properties LatLon.epsilon and LatLon.iterations.

Instance Methods
 
bearingTo(self, other, wrap=False)
DEPRECATED, use method initialBearingTo.
 
toCartesian(self, **Cartesian_datum_kwds)
Convert this point to Vincenty-based cartesian (ECEF) coordinates.

Inherited from ellipsoidalBaseDI.LatLonEllipsoidalBaseDI: bearingTo2, destination, destination2, distanceTo, distanceTo3, finalBearingOn, finalBearingTo, initialBearingTo, intermediateTo

Inherited from ellipsoidalBase.LatLonEllipsoidalBase: __init__, antipode, convertDatum, convertRefFrame, distanceTo2, elevation2, ellipsoid, ellipsoids, geoidHeight2, intersection3, intersections2, nearestOn, parse, to3xyz, toDatum, toEtm, toLcc, toMgrs, toOsgr, toRefFrame, toUps, toUtm, toUtmUps, toWm, trilaterate5

Inherited from latlonBase.LatLonBase: PointsIter, __eq__, __ne__, __str__, _distanceTo_, bounds, boundsOf, chordTo, compassAngle, compassAngleTo, cosineAndoyerLambertTo, cosineForsytheAndoyerLambertTo, cosineLawTo, destinationXyz, equals, equals3, equirectangularTo, euclideanTo, flatLocalTo, flatPolarTo, haversineTo, heightStr, hubenyTo, isantipode, isantipodeTo, isequalTo, isequalTo3, latlon2, latlon2round, latlon_, philam2, points, points2, thomasTo, to2ab, to3llh, toEcef, toLocal, toLtp, toNvector, toStr, toVector, toVector3d, vincentysTo

Inherited from named._NamedBase: __repr__, others, toRepr

Inherited from named._Named: _DOT_, attrs, classof, copy, rename, toStr2

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Properties
  Ecef
Get the ECEF class (EcefVeness), lazily.
  epsilon
Property to get and set the convergence epsilon (radians).
  iterations
Property to get and set the iteration limit (int).

Inherited from ellipsoidalBaseDI.LatLonEllipsoidalBaseDI: geodesic

Inherited from ellipsoidalBase.LatLonEllipsoidalBase: Equidistant, convergence, datum, epoch, iteration, reframe, scale

Inherited from latlonBase.LatLonBase: height, isEllipsoidal, isSpherical, lam, lat, latlon, latlonheight, lon, phi, philam, philamheight, xyz, xyzh

Inherited from named._Named: classname, classnaming, name, named, named2, named3, named4

Inherited from object: __class__

Method Details

bearingTo (self, other, wrap=False)

 

DEPRECATED, use method initialBearingTo.

Decorators:
  • @deprecated_method

toCartesian (self, **Cartesian_datum_kwds)

 

Convert this point to Vincenty-based cartesian (ECEF) coordinates.

Arguments:
  • Cartesian_datum_kwds - Optional Cartesian, datum and other keyword arguments, ignored if Cartesian=None. Use Cartesian=... to override this Cartesian class or specify Cartesian=None.
Returns:
The cartesian point (Cartesian) or if Cartesian is None, an Ecef9Tuple(x, y, z, lat, lon, height, C, M, datum) with C and M if available.
Raises:
  • TypeError - Invalid Cartesian, datum or other Cartesian_datum_kwds.
Overrides: latlonBase.LatLonBase.toCartesian

Property Details

Ecef

Get the ECEF class (EcefVeness), lazily.

Get method:
Ecef(self) - Get the ECEF class (EcefVeness), lazily.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

epsilon

Property to get and set the convergence epsilon (radians).

Get method:
epsilon(self) - Get the convergence epsilon (radians).
Set method:
epsilon(self, epsilon) - Set the convergence epsilon.

iterations

Property to get and set the iteration limit (int).

Get method:
iterations(self) - Get the iteration limit (int).
Set method:
iterations(self, limit) - Set the iteration limit.