Package pygeodesy :: Module ellipsoidalVincenty :: Class LatLon

Class LatLon

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

New point on an (oblate) ellipsoidal earth model, using the formulae devised by Thaddeus Vincenty (1975) to compute geodesic distances, bearings (azimuths), etc.

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.

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 or bearingTo2.

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, intersecant2, nearestOn8, plumbTo

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

Inherited from latlonBase.LatLonBase: PointsIter, __eq__, __ne__, __str__, bounds, boundsOf, chordTo, circin6, circum3, circum4_, compassAngle, compassAngleTo, cosineAndoyerLambertTo, cosineForsytheAndoyerLambertTo, cosineLawTo, destinationXyz, equals, equals3, equirectangularTo, euclideanTo, flatLocalTo, flatPolarTo, hartzell, haversineTo, height4, heightStr, hubenyTo, isantipode, isantipodeTo, isequalTo, isequalTo3, latlon2, latlon2round, latlon_, nearestOn6, nearestTo, normal, philam2, points, points2, radii11, rhumbAzimuthTo, rhumbDestination, rhumbDistanceTo, rhumbIntersecant2, rhumbLine, rhumbMidpointTo, thomasTo, to2ab, to3llh, toEcef, toNormal, toNvector, toStr, toVector, toVector3d, toWm, vincentysTo

Inherited from named._NamedBase: __repr__, others, toRepr

Inherited from named._Named: __format__, __imatmul__, __matmul__, __rmatmul__, attrs, classof, copy, dup, methodname, rename, renamed, toStr2

Inherited from named._NamedLocal: toAer, toEnu, toLocal, toLtp, toNed, toXyz

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

Properties
	Ecef Get the ECEF class (EcefVeness), once.
	epsilon Class `property` with a `.name` attribute.
	iterations Class `property` with a `.name` attribute.
Inherited from `ellipsoidalBaseDI.LatLonEllipsoidalBaseDI`: `geodesic` Inherited from `ellipsoidalBase.LatLonEllipsoidalBase`: `Equidistant`, `convergence`, `datum`, `ellipsoidalLatLon`, `epoch`, `gamma`, `iteration`, `reframe`, `scale` Inherited from `latlonBase.LatLonBase`: `clipid`, `height`, `isEllipsoidal`, `isSpherical`, `isnormal`, `lam`, `lat`, `latlon`, `latlonheight`, `lon`, `phi`, `philam`, `philamheight`, `sphericalLatLon`, `xyz`, `xyz3`, `xyzh` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2`, `named3`, `named4`, `sizeof` Inherited from `object`: `__class__`

Method Details

bearingTo (self, other, wrap=False)

DEPRECATED, use method initialBearingTo or bearingTo2.

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), once.

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

epsilon

Class property with a .name attribute.

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

iterations

Class property with a .name attribute.

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