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

# Class HeightIDWkarney

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

Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in `degrees` from Karney's geographiclib Geodesic Inverse method.

See Also: HeightIDWcosineAndoyerLambert, HeightIDWcosineForsytheAndoyerLambert, HeightIDWdistanceTo, HeightIDWflatLocal, HeightIDWhubeny, HeightIDWthomas, IDW and SHEPARD_INTERP_2D.

Instance Methods
__init__(self, knots, datum=None, beta=2, wrap=False, name='') New HeightIDWkarney 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 `named._Named`: `__imatmul__`, `__matmul__`, `__repr__`, `__rmatmul__`, `__str__`, `attrs`, `classof`, `copy`, `dup`, `methodname`, `rename`, `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`, `numpy`, `scipy`, `scipy_interpolate`, `wrap` Inherited from `named._Named`: `classname`, `classnaming`, `iteration`, `name`, `named`, `named2`, `named3`, `named4` Inherited from `object`: `__class__`

Method Details

### __init__ (self, knots, datum=None, beta=2, wrap=False, name='') (Constructor) |
New HeightIDWkarney interpolator. Arguments: `knots` - The points with known height (`LatLon`s). `datum` - Optional datum overriding the default `Datums.WGS84` and first `knots`' datum (Datum, Ellipsoid, Ellipsoid2 or a_f2Tuple). `beta` - Inverse distance power (`int` 1, 2, or 3). `wrap` - Wrap and pygeodesy.unroll180 longitudes (`bool`). `name` - Optional name for this height interpolator (`str`). Raises: `HeightError` - Insufficient number of `knots` or an invalid `knot`, `datum` or `beta`. `ImportError` - Package geographiclib missing. `TypeError` - Invalid `datum`. Overrides: object.__init__

### __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 pygeodesy.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 pygeodesy.fidw issue. Overrides: _HeightIDW.height