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

# Module heights

Classes to interpolate the height of `LatLon` locations or separate lat-/longitudes.

Except for the HeightIDW interpolator, the height interpolators in this module require numpy and scipy 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 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: 19.02.24

Classes
| HeightError Height interpolator or interpolation error.
| SciPyError Error raised for `SciPy` errors.
| SciPyWarning Exception thrown for `SciPy` warnings.
| HeightCubic Height interpolator based on `SciPy` interp2d `kind='cubic'`.
| HeightLinear Height interpolator based on `SciPy` interp2d `kind='linear]`.
| HeightIDW Height interpolator using Inverse Distance Weighting (IDW).
| HeightLSQBiSpline Height interpolator using `SciPy` LSQSphereBivariateSpline.
| HeightSmoothBiSpline Height interpolator using `SciPy` SmoothSphereBivariateSpline.

Variables
| __all__ = `_ALL_LAZY.heights`