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

# Class LatLonEllipsoidalBaseDI

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

Known Subclasses:
  - ellipsoidalExact.LatLon
  - , ellipsoidalGeodSolve.LatLon
  - , ellipsoidalKarney.LatLon
  - , ellipsoidalVincenty.LatLon

(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. |
nearestOn8(self, points, closed=False, height=None, wrap=False, equidistant=None, tol=0.001) Iteratively locate the point on a path or polygon closest to this point. |
Inherited from `ellipsoidalBase.LatLonEllipsoidalBase`: `__init__`, `antipode`, `convertDatum`, `convertRefFrame`, `distanceTo2`, `elevation2`, `ellipsoid`, `ellipsoids`, `geoidHeight2`, `intersection3`, `intersections2`, `midpointTo`, `nearestOn`, `parse`, `to3xyz`, `toCss`, `toDatum`, `toEtm`, `toLcc`, `toMgrs`, `toOsgr`, `toRefFrame`, `toUps`, `toUtm`, `toUtmUps`, `toWm`, `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`, `normal`, `philam2`, `points`, `points2`, `radii11`, `rhumbAzimuthTo`, `rhumbDestination`, `rhumbDistanceTo`, `rhumbLine`, `rhumbMidpointTo`, `thomasTo`, `to2ab`, `to3llh`, `toCartesian`, `toEcef`, `toLocal`, `toLtp`, `toNvector`, `toStr`, `toVector`, `toVector3d`, `vincentysTo` Inherited from `named._NamedBase`: `__repr__`, `others`, `toRepr` Inherited from `named._Named`: `__imatmul__`, `__matmul__`, `__rmatmul__`, `attrs`, `classof`, `copy`, `dup`, `methodname`, `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`, `gamma`, `isEllipsoidalLatLon`, `iteration`, `reframe`, `scale` Inherited from `latlonBase.LatLonBase`: `Ecef`, `height`, `isEllipsoidal`, `isSpherical`, `isnormal`, `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 (`scalar`, 0.0 at this and 1.0 at the other point. `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. Overrides: ellipsoidalBase.LatLonEllipsoidalBase.intermediateTo See Also: Methods distanceTo3, destination, `midpointTo` and `rhumbMidpointTo`.

### nearestOn8 (self, points, closed=False, height=None, wrap=False, equidistant=None, tol=0.001) |
Iteratively locate the point on a path or polygon closest to this point. Arguments: `points` - The path or polygon points (`LatLon`[]). `closed` - Optionally, close the polygon (`bool`). `height` - Optional height, overriding the height of this and all other points (`meter`, conventionally). If `height` is `None`, the height of each point is taken into account for distances. Returns: A NearestOn8Tuple`(closest, distance, fi, j, start, end, initial, final)` with `distance` in `meter`, conventionally and with the `closest`, the `start` the `end` point each an instance of this `LatLon`. Raises: `PointsError` - Insufficient number of `points`. `TypeError` - Some `points` or `equidistant` invalid. `ValueError` - Some `points`' datum or ellipsoid incompatible or no convergence for the given `tol`. See Also: Function pygeodesy.nearestOn6 and method `nearestOn6`.

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.