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

# Class HeightIDWdistanceTo

      object --+
               |
    named._Named --+
                   |
         _HeightBase --+
                       |
              _HeightIDW --+
                           |
                          HeightIDWdistanceTo

Height interpolator using Inverse Distance Weighting (IDW) and the distance from the points' `LatLon.distanceTo` method, conventionally in `meter`.

See Also: HeightIDWcosineAndoyerLambert, HeightIDWcosineForsytheAndoyerLambert, HeightIDWflatPolar, HeightIDWkarney, HeightIDWthomas, IDW and SHEPARD_INTERP_2D.

Instance Methods
__init__(self, knots, beta=2, name=`'````'`, **distanceTo_kwds) New HeightIDWdistanceTo interpolator. |
__call__(self, *llis) Interpolate the height for one or several locations. |
height(self, lats, lons) Interpolate the height for one or several lat-/longitudes. |
Inherited from `_HeightIDW`: `_distances_angular_`, `_distances_angular_datum_` Inherited from `named._Named`: `__repr__`, `__str__`, `_dot_`, `attrs`, `classof`, `copy`, `toRepr`, `toStr`, `toStr2` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
Inherited from `_HeightIDW`: `beta` Inherited from `_HeightBase`: `adjust`, `datum`, `kmin`, `wrap` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2` Inherited from `object`: `__class__`

Method Details

### __init__ (self, knots, beta=2, name=`'````'`, **distanceTo_kwds) (Constructor) |
New HeightIDWdistanceTo interpolator. Arguments: `knots` - The points with known height (`LatLon`s). `beta` - Inverse distance power (`int` 1, 2, or 3). `name` - Optional name for this height interpolator (`str`). `distanceTo_kwds` - Optional keyword arguments for the `points`' `LatLon.distanceTo` method. Raises: `HeightError` - Insufficient number of `knots` or an invalid `knot` or `beta`. `ImportError` - Package GeographicLib missing iff `points` are ellipsoidalKarney.LatLons. Overrides: object.__init__ Note: All `points` must be instances of the same ellipsoidal or spherical `LatLon` class, not checked however.

### __call__ (self, *llis) (Call operator) |
Interpolate the height for one or several locations. Arguments: `llis` - The location or locations (`LatLon`, ... or `LatLon`s). Returns: A single interpolated height (`float`) or a list or tuple of interpolated heights (`float`s). Raises: `HeightError` - Insufficient number of `llis`, an invalid `lli` or an fidw issue. Overrides: _HeightBase.__call__

### height (self, lats, lons) |
Interpolate the height for one or several lat-/longitudes. Arguments: `lats` - Latitude or latitudes (`degrees` or `degrees`s). `lons` - Longitude or longitudes (`degrees` or `degrees`s). Returns: A single interpolated height (`float`) or a list of interpolated heights (`float`s). Raises: `HeightError` - Insufficient or non-matching number of `lats` and `lons` or an fidw issue. Overrides: _HeightIDW.height