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

Module heights

Height interpolation methods.

Classes HeightCubic, HeightIDWcosineAndoyerLambert, HeightIDWcosineForsytheAndoyerLambert, HeightIDWcosineLaw, HeightIDWdistanceTo, HeightIDWequirectangular, HeightIDWeuclidean, HeightIDWflatLocal, HeightIDWflatPolar, HeightIDWhaversine, HeightIDWhubeny, HeightIDWkarney, HeightIDWthomas, 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. Classes HeightIDWkarney and HeightIDWdistanceTo -iff used with ellipsoidalKarney.LatLon points- require 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)

Then, 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- and longitudes invoke the .height method

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

or

>>> h0, h1, h2, ... = hinterpolator.height(lats, lons) # lists, tuples, ...

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: 21.06.01

Classes
  HeightError
Height interpolator Height... or interpolation issue.
  _HeightBase
(INTERNAL) Interpolator base class.
  HeightCubic
Height interpolator based on SciPy interp2d kind='cubic'.
  HeightLinear
Height interpolator based on SciPy interp2d kind='linear'.
  HeightIDWcosineAndoyerLambert
Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in radians from function cosineAndoyerLambert_.
  HeightIDWcosineForsytheAndoyerLambert
Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in radians from function cosineForsytheAndoyerLambert_.
  HeightIDWcosineLaw
Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in radians from function cosineLaw_.
  HeightIDWdistanceTo
Height interpolator using Inverse Distance Weighting (IDW) and the distance from the points' LatLon.distanceTo method, conventionally in meter.
  HeightIDWequirectangular
Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in radians squared like function equirectangular_.
  HeightIDWeuclidean
Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in radians from function euclidean_.
  HeightIDWflatLocal
Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in radians squared like function flatLocal_/hubeny_.
  HeightIDWflatPolar
Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in radians from function flatPolar_.
  HeightIDWhaversine
Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in radians from function haversine_.
  HeightIDWhubeny
Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in radians squared like function flatLocal_/hubeny_.
  HeightIDWkarney
Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in degrees from Karney's geographiclib Geodesic Inverse method.
  HeightIDWthomas
Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in radians from function thomas_.
  HeightIDWvincentys
Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in radians from function vincentys_.
  HeightLSQBiSpline
Height interpolator using SciPy LSQSphereBivariateSpline.
  HeightSmoothBiSpline
Height interpolator using SciPy SmoothSphereBivariateSpline.
Variables
  __all__ = _ALL_LAZY.heights