Package pygeodesy :: Module ellipsoidalBaseDI :: Class LatLonEllipsoidalBaseDI
[frames] | no frames]

Class LatLonEllipsoidalBaseDI

               object --+                
                        |                
             named._Named --+            
                            |            
             named._NamedBase --+        
                                |        
            latlonBase.LatLonBase --+    
                                    |    
ellipsoidalBase.LatLonEllipsoidalBase --+
                                        |
                                       LatLonEllipsoidalBaseDI
Known Subclasses:

(INTERNAL) Base class for ellipsoidal*.LatLon classes with overloaded Direct and Inverse methods.

Instance Methods
 
bearingTo2(self, other, wrap=False)
Compute the initial and final bearing (forward and reverse azimuth) from this to an other point, using this Inverse method.
 
destination(self, distance, bearing, height=None)
Compute the destination point after having travelled for the given distance from this point along a geodesic given by an initial bearing, using this Direct method.
 
destination2(self, distance, bearing, height=None)
Compute the destination point and the final bearing (reverse azimuth) after having travelled for the given distance from this point along a geodesic given by an initial bearing, using this Direct method.
 
distanceTo(self, other, wrap=False, **unused)
Compute the distance between this and an other point along a geodesic, using this Inverse method.
 
distanceTo3(self, other, wrap=False)
Compute the distance, the initial and final bearing along a geodesic between this and an other point, using this Inverse method.
 
finalBearingOn(self, distance, bearing)
Compute the final bearing (reverse azimuth) after having travelled for the given distance along a geodesic given by an initial bearing from this point, using this Direct method.
 
finalBearingTo(self, other, wrap=False)
Compute the final bearing (reverse azimuth) after having travelled along a geodesic from this point to an other point, using this Inverse method.
 
initialBearingTo(self, other, wrap=False)
Compute the initial bearing (forward azimuth) to travel along a geodesic from this point to an other point, using this Inverse method.
 
intermediateTo(self, other, fraction, height=None, wrap=False)
Return the point at given fraction along the geodesic between this and an other point, using this Direct and Inverse methods.

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, toCartesian, 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
  geodesic
N/A, invalid (None always).

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

Inherited from latlonBase.LatLonBase: Ecef, 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

bearingTo2 (self, other, wrap=False)

 

Compute the initial and final bearing (forward and reverse azimuth) from this to an other point, using this Inverse method. See methods initialBearingTo and finalBearingTo for more details.

Arguments:
  • other - The other point (LatLon).
  • wrap - Wrap and unroll longitudes (bool).
Returns:
A Bearing2Tuple(initial, final).
Raises:
  • TypeError - The other point is not LatLon.
  • ValueError - If this and the other point's Datum ellipsoids are not compatible.

destination (self, distance, bearing, height=None)

 

Compute the destination point after having travelled for the given distance from this point along a geodesic given by an initial bearing, using this Direct method. See method destination2 for more details.

Arguments:
  • distance - Distance (meter).
  • bearing - Initial bearing in (compass degrees360).
  • height - Optional height, overriding the default height (meter, same units as distance).
Returns:
The destination point (LatLon).

destination2 (self, distance, bearing, height=None)

 

Compute the destination point and the final bearing (reverse azimuth) after having travelled for the given distance from this point along a geodesic given by an initial bearing, using this Direct method.

The distance must be in the same units as this point's datum axes, conventionally meter. The distance is measured on the surface of the ellipsoid, ignoring this point's height.

The initial and final bearing (forward and reverse azimuth) are in compass degrees360.

The destination point's height and datum are set to this point's height and datum, unless the former is overridden.

Arguments:
  • distance - Distance (meter).
  • bearing - Initial bearing (compass degrees360).
  • height - Optional height, overriding the default height (meter, same units as distance).
Returns:
A Destination2Tuple(destination, final).

distanceTo (self, other, wrap=False, **unused)

 

Compute the distance between this and an other point along a geodesic, using this Inverse method. See method distanceTo3 for more details.

Arguments:
  • other - The other point (LatLon).
  • wrap - Wrap and unroll longitudes (bool).
Returns:
Distance (meter).
Raises:
  • TypeError - The other point is not LatLon.
  • ValueError - If this and the other point's Datum ellipsoids are not compatible.

distanceTo3 (self, other, wrap=False)

 

Compute the distance, the initial and final bearing along a geodesic between this and an other point, using this Inverse method.

The distance is in the same units as this point's datum axes, conventionally meter. The distance is measured on the surface of the ellipsoid, ignoring this point's height.

The initial and final bearing (forward and reverse azimuth) are in compass degrees360 from North.

Arguments:
  • other - Destination point (LatLon).
  • wrap - Wrap and unroll longitudes (bool).
Returns:
A Distance3Tuple(distance, initial, final).
Raises:
  • TypeError - The other point is not LatLon.
  • ValueError - If this and the other point's Datum ellipsoids are not compatible.

finalBearingOn (self, distance, bearing)

 

Compute the final bearing (reverse azimuth) after having travelled for the given distance along a geodesic given by an initial bearing from this point, using this Direct method. See method destination2 for more details.

Arguments:
  • distance - Distance (meter).
  • bearing - Initial bearing (compass degrees360).
Returns:
Final bearing (compass degrees360).

finalBearingTo (self, other, wrap=False)

 

Compute the final bearing (reverse azimuth) after having travelled along a geodesic from this point to an other point, using this Inverse method. See method distanceTo3 for more details.

Arguments:
  • other - The other point (LatLon).
  • wrap - Wrap and unroll longitudes (bool).
Returns:
Final bearing (compass degrees360).
Raises:
  • TypeError - The other point is not LatLon.
  • ValueError - If this and the other point's Datum ellipsoids are not compatible.

initialBearingTo (self, other, wrap=False)

 

Compute the initial bearing (forward azimuth) to travel along a geodesic from this point to an other point, using this Inverse method. See method distanceTo3 for more details.

Arguments:
  • other - The other point (LatLon).
  • wrap - Wrap and unroll longitudes (bool).
Returns:
Initial bearing (compass degrees360).
Raises:
  • TypeError - The other point is not LatLon.
  • ValueError - If this and the other point's Datum ellipsoids are not compatible.

intermediateTo (self, other, fraction, height=None, wrap=False)

 

Return the point at given fraction along the geodesic between this and an other point, using this Direct and Inverse methods.

Arguments:
  • other - The other point (LatLon).
  • fraction - Fraction between both points ranging from 0, meaning this to 1, the other point (float).
  • height - Optional height, overriding the fractional height (meter).
  • wrap - Wrap and unroll longitudes (bool).
Returns:
Intermediate point (LatLon).
Raises:
  • TypeError - The other point is not LatLon.
  • UnitError - Invalid fraction or height.
  • ValueError - If this and the other point's Datum ellipsoids are not compatible.

See Also: Methods distanceTo3 and destination.


Property Details

geodesic

N/A, invalid (None always).

Get method:
geodesic(self) - N/A, invalid (None always).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.