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

# Module heights

Classes HeightCubic, HeightIDWcosineLaw, HeightIDWequirectangular, HeightIDWeuclidean, HeightIDWhaversine, HeightIDWkarney, HeightIDWvincentys, HeightLinear, HeightLSQBiSpline and HeightSmoothBiSpline to interpolate the height of `LatLon` locations or separate lat-/longitudes from a set of `LatLon` points with known heights.

Classes HeightCubic and HeightLinear require package numpy, classes HeightLSQBiSpline and HeightSmoothBiSpline require package scipy and class HeightIDWkarney requires Charles Karney's geographiclib to be installed.

Typical usage is as follows. First create an interpolator from a given set of `LatLon` points with known heights, called `knots`.

`hinterpolator = HeightXyz(knots, **options)`

Get the interpolated height of other `LatLon` location(s) with

`h = hinterpolator(ll)`

or

`h0, h1, h2, ... = hinterpolator(ll0, ll1, ll2, ...)`

or

`hs = hinterpolator(lls)` # `list, tuple, generator, ...`

For separate lat-/longitudes invoke the `.height` method

`h = hinterpolator.height(lat, lon)`

or

`h0, h1, h2, ... = hinterpolator.height(lats, lons)` # `list, ...`

The `knots` do not need to be ordered for any of the height interpolators.

Errors from `scipy` as raised as SciPyErrors. Warnings issued by `scipy` can be thrown as SciPyWarning exceptions, provided Python `warnings` are filtered accordingly, see SciPyWarning.

See Also: SciPy.

Version: 20.04.04

Classes
| HeightError Height interpolator `Height...` or interpolation issue.
| SciPyError Error raised for `SciPy` errors.
| SciPyWarning Exception thrown for `SciPy` warnings.
| _HeightBase (INTERNAL) Interpolator base class.
| HeightCubic Height interpolator based on `SciPy` interp2d `kind='cubic'`.
| HeightLinear Height interpolator based on `SciPy` interp2d `kind='linear`.
| HeightIDWcosineLaw Height interpolator using Inverse Distance Weighting (IDW) and the distance in `radians` from function cosineLaw_.
| HeightIDWequirectangular Height interpolator using Inverse Distance Weighting (IDW) and the distance in `radians squared` like function equirectangular_.
| HeightIDWeuclidean Height interpolator using Inverse Distance Weighting (IDW) and the distance in `radians` from function euclidean_.
| HeightIDWflatLocal Height interpolator using Inverse Distance Weighting (IDW) and the distance in `radians squared` like function flatLocal_.
| HeightIDWflatPolar Height interpolator using Inverse Distance Weighting (IDW) and the distance in `radians` from function flatPolar_.
| HeightIDWhaversine Height interpolator using Inverse Distance Weighting (IDW) and the distance in `radians` from function haversine_.
| HeightIDWkarney Height interpolator using Inverse Distance Weighting (IDW) and the distance in `degrees` from Charles F. F. Karney's GeographicLib Geodesic Inverse method.
| HeightIDWvincentys Height interpolator using Inverse Distance Weighting (IDW) and the distance in `radians` from function vincentys_.
| HeightLSQBiSpline Height interpolator using `SciPy` LSQSphereBivariateSpline.
| HeightSmoothBiSpline Height interpolator using `SciPy` SmoothSphereBivariateSpline.