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

# Class LatLon

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

An ellipsoidal LatLon similar to ellipsoidalVincenty.LatLon but using Charles F. F. Karney's Python GeographicLib to compute the geodesic distance, initial and final bearing (azimuths) between two given points or the destination point given a start point and an initial bearing.

Note: This LatLon's methods require the GeographicLib package.

Instance Methods
bearingTo(self, other, wrap=False) DEPRECATED, use method `initialBearingTo`. |
bearingTo2(self, other, wrap=False) Compute the initial and final bearing (forward and reverse azimuth) from this to an other point, using Karney's `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 Karney's `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 Karney's `Direct` method. |
distanceTo(self, other, wrap=False) Compute the distance between this and an other point along a geodesic, using Karney's `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 Karney's `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 Karney's `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 Karney's `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 Karney's `Inverse` method. |
toCartesian(self, **Cartesian_datum_kwds) Convert this point to `Karney`-based cartesian (ECEF) coordinates. |
Inherited from `ellipsoidalBase.LatLonEllipsoidalBase`: `__init__`, `antipode`, `convertDatum`, `convertRefFrame`, `distanceTo2`, `elevation2`, `ellipsoid`, `ellipsoids`, `geoidHeight2`, `parse`, `to3xyz`, `toEtm`, `toLcc`, `toOsgr`, `toUps`, `toUtm`, `toUtmUps`, `toWm` Inherited from `latlonBase.LatLonBase`: `__eq__`, `__ne__`, `__str__`, `bounds`, `boundsOf`, `compassAngle`, `compassAngleTo`, `equals`, `equals3`, `equirectangularTo`, `euclideanTo`, `flatLocalTo`, `flatPolarTo`, `haversineTo`, `isantipode`, `isantipodeTo`, `isequalTo`, `isequalTo3`, `latlon2`, `latlon2round`, `latlon_`, `philam2`, `points`, `points2`, `to2ab`, `to3llh`, `toEcef`, `toNvector`, `toStr`, `toVector`, `toVector3d`, `vincentysTo` Inherited from `named._NamedBase`: `__repr__`, `others`, `toStr2` Inherited from `named._Named`: `_dot_`, `attrs`, `classof`, `copy` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
| geodesic
Inherited from `ellipsoidalBase.LatLonEllipsoidalBase`: `convergence`, `datum`, `epoch`, `isEllipsoidal`, `isSpherical`, `iteration`, `reframe`, `scale` Inherited from `latlonBase.LatLonBase`: `Ecef`, `height`, `lam`, `lat`, `latlon`, `latlonheight`, `lon`, `phi`, `philam`, `philamheight`, `xyz`, `xyzh` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2` 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 Karney's `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: `ImportError` - Package geographiclib not installed or not found. `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 Karney's `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). Raises: `ImportError` - Package geographiclib not installed or not found. Example:
    >>> p = LatLon(-37.95103, 144.42487)
    >>> d = p.destination(54972.271, 306.86816)
    >>> d
    LatLon(37°39′10.14″S, 143°55′35.39″E)  # 37.652818°S, 143.926498°E

### 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 Karney's `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)`. Raises: `ImportError` - Package geographiclib not installed or not found. Example:
    >>> p = LatLon(-37.95103, 144.42487)
    >>> d, f = p.destination2(54972.271, 306.86816)
    >>> d
    LatLon(37°39′10.14″S, 143°55′35.39″E)  # 37.652818°S, 143.926498°E
    >>> f
    307.1736313846665

### distanceTo (self, other, wrap=False) |
Compute the distance between this and an other point along a geodesic, using Karney's `Inverse` method. See method distanceTo3 for more details. Arguments: `other` - The other point (LatLon). `wrap` - Wrap and unroll longitudes (`bool`). Returns: Distance (`meter`). Raises: `ImportError` - Package geographiclib not installed or not found. `TypeError` - The `other` point is not LatLon. `ValueError` - If this and the `other` point's Datum ellipsoids are not compatible. Example:
    >>> p = LatLon(50.06632, -5.71475)
    >>> q = LatLon(58.64402, -3.07009)
    >>> d = p.distanceTo(q)  # 969,954.1663142084 m

### distanceTo3 (self, other, wrap=False) |
Compute the distance, the initial and final bearing along a geodesic between this and an other point, using Karney's `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: `ImportError` - Package geographiclib not installed or not found. `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 Karney's `Direct` method. See method destination2 for more details. Arguments: `distance` - Distance (`meter`). `bearing` - Initial bearing (compass `degrees360`). Returns: Final bearing (compass `degrees360`). Raises: `ImportError` - Package geographiclib not installed or not found. Example:
    >>> p = LatLon(-37.95103, 144.42487)
    >>> b = 306.86816
    >>> f = p.finalBearingOn(54972.271, b)  # 307.1736313846665°

### 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 Karney's `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: `ImportError` - Package geographiclib not installed or not found. `TypeError` - The `other` point is not LatLon. `ValueError` - If this and the `other` point's Datum ellipsoids are not compatible. Example:
    >>> p = new LatLon(50.06632, -5.71475)
    >>> q = new LatLon(58.64402, -3.07009)
    >>> f = p.finalBearingTo(q)  # 11.297220414306684°
    >>> p = LatLon(52.205, 0.119)
    >>> q = LatLon(48.857, 2.351)
    >>> f = p.finalBearingTo(q)  # 157.83449958372714°

### initialBearingTo (self, other, wrap=False) |
Compute the initial bearing (forward azimuth) to travel along a geodesic from this point to an other point, using Karney's `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: `ImportError` - Package geographiclib not installed or not found. `TypeError` - The `other` point is not LatLon. `ValueError` - If this and the `other` point's Datum ellipsoids are not compatible. Example:
    >>> p = LatLon(50.06632, -5.71475)
    >>> q = LatLon(58.64402, -3.07009)
    >>> b = p.initialBearingTo(q)  # 9.141877488906045°
    >>> p = LatLon(52.205, 0.119)
    >>> q = LatLon(48.857, 2.351)
    >>> b = p.initialBearingTo(q)  # 156.1106404059787°
JS name: bearingTo.

### toCartesian (self, **Cartesian_datum_kwds) |
Convert this point to `Karney`-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 set `Cartesian=None`. Returns: The cartesian (ECEF) coordinates (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

### geodesic Get method: geodesic(self) - Get this `LatLon`'s Geodesic, provided package geographiclib is installed. Set method: immutable(inst, value) - Throws an `AttributeError`, always.