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 from Charles F. F. Karney's GeographicLib Geodesic Inverse method.

See Also: HeightIDWequirectangular, HeightIDWeuclidean, HeightIDWhaversine, HeightIDWvincentys, Inverse distance weighting, IDW and SHEPARD_INTERP_2D.

Instance Methods
__init__(self, knots, datum=None, beta=2, wrap=False, name=`'````'`) New HeightIDWhaversine 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`: `__repr__`, `__str__`, `classof`, `copy`, `toStr`, `toStr2` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
| datum Get the datum of this interpolator (Datum).
Inherited from `_HeightIDW`: `beta` Inherited from `_HeightBase`: `adjust`, `kmin`, `wrap` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2` Inherited from `object`: `__class__`

Method Details

### __init__(self, knots, datum=None, beta=2, wrap=False, name=`'````'`) (Constructor) |
New HeightIDWhaversine interpolator. Parameters: `knots` - The points with known height (`LatLon`s). `datum` - Optional datum (Datum to use, overriding the default `knots[0].datum` `beta` - Inverse distance power (`int` 1, 2, or 3). `wrap` - Wrap and unroll180 longitudes (`bool`). `name` - Optional height interpolator name (`str`). Raises: `HeightError` - Insufficient number of `knots` or 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. Parameters: `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`, invalid `lli` or an fidw issue. Overrides: _HeightBase.__call__

### height(self, lats, lons) |
Interpolate the height for one or several lat-/longitudes. Parameters: `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

Property Details

### datum Get the datum of this interpolator (Datum). Get Method: datum(self) - Get the datum of this interpolator (Datum). Set Method: Read_Only(self, ignored) - Throws an `AttributeError`, always.