Package pygeodesy :: Module ellipsoidalNvector |
[frames] | no frames]

# Module ellipsoidalNvector

N-vector-based classes geodetic (lat-/longitude) LatLon, geocentric (ECEF) Cartesian, Ned and Nvector and functions meanOf and toNed, all ellipsoidal.

Pure Python implementation of n-vector-based geodetic (lat-/longitude) methods by (C) Chris Veness 2011-2016 published under the same MIT Licence**, see Vector-based geodesy.

These classes and functions work with: (a) geodesic (polar) lat-/longitude points on the earth's surface and (b) 3-D vectors used as n-vectors representing points on the earth's surface or vectors normal to the plane of a great circle.

See also Kenneth Gade 'A Non-singular Horizontal Position Representation', The Journal of Navigation (2010), vol 63, nr 3, pp 395-417.

Version: 20.04.11

Classes
| Cartesian Extended to convert geocentric, Cartesian points to Nvector and n-vector-based, geodetic LatLon.
| LatLon An n-vector-based, ellipsoidal LatLon point.
| Ned North-Eeast-Down (NED), also known as Local Tangent Plane (LTP), is a vector in the local coordinate frame of a body.
| Nvector An n-vector is a position representation using a (unit) vector normal to the earth ellipsoid.

Functions
meanOf(points, datum=Datum(name='WGS84', ellipsoid=Ellipsoids.WGS84, transform=Tran`...`, height=None, LatLon=<class 'pygeodesy.ellipsoidalNvector.LatLon'>, **LatLon_kwds) Compute the geographic mean of several points. |
sumOf(nvectors, Vector=<class 'pygeodesy.ellipsoidalNvector.Nvector'>, h=None, **Vector_kwds) Return the vectorial sum of two or more n-vectors. |
toNed(distance, bearing, elevation, Ned=<class 'pygeodesy.ellipsoidalNvector.Ned'>, name=`'````'`) Create an NED vector from distance, bearing and elevation (in local coordinate system). |

Function Details

### meanOf (points, datum=Datum(name='WGS84', ellipsoid=Ellipsoids.WGS84, transform=Tran`...`, height=None, LatLon=<class 'pygeodesy.ellipsoidalNvector.LatLon'>, **LatLon_kwds) |
Compute the geographic mean of several points. Arguments: `points` - Points to be averaged (LatLon[]). `datum` - Optional datum to use (Datum). `height` - Optional height at mean point, overriding the mean height (`meter`). `LatLon` - Optional class to return the mean point (LatLon) or `None`. `LatLon_kwds` - Optional, additional `LatLon` keyword arguments, ignored if `LatLon=None`. Returns: Geographic mean point and mean height (`LatLon`) or a LatLon3Tuple`(lat, lon, height)` if `LatLon` is `None`. Raises: `ValueError` - Insufficient number of `points`.

### sumOf (nvectors, Vector=<class 'pygeodesy.ellipsoidalNvector.Nvector'>, h=None, **Vector_kwds) |
Return the vectorial sum of two or more n-vectors. Arguments: `nvectors` - Vectors to be added (Nvector[]). `Vector` - Optional class for the vectorial sum (Nvector). `h` - Optional height, overriding the mean height (`meter`). `Vector_kwds` - Optional, additional `Vector` keyword arguments, ignored if `Vector=None`. Returns: Vectorial sum (`Vector`). Raises: `VectorError` - No `nvectors`.

### toNed (distance, bearing, elevation, Ned=<class 'pygeodesy.ellipsoidalNvector.Ned'>, name=`'````'`) |
Create an NED vector from distance, bearing and elevation (in local coordinate system). Arguments: `distance` - NED vector length (`meter`). `bearing` - NED vector bearing (compass `degrees360`). `elevation` - NED vector elevation from local coordinate frame horizontal (`degrees`). `Ned` - Optional class to return the NED (Ned) or `None`. `name` - Optional name (`str`). Returns: An NED vector equivalent to this `distance`, `bearing` and `elevation` (Ned) or if `Ned=None`, an Ned3Tuple`(north, east, down)`. Raises: `ValueError` - Invalid `distance`, `bearing` or `elevation`. JS name: fromDistanceBearingElevation.