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

# Class HeightLinear

     object --+
              |
    _HeightBase --+
                  |
        HeightCubic --+
                      |
                     HeightLinear

Height interpolator based on `SciPy` interp2d `kind='linear]`.

Instance Methods
__init__(self, knots) New HeightLinear 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 `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__sizeof__`, `__str__`, `__subclasshook__`

Properties
Inherited from `object`: `__class__`

Method Details

### __init__(self, knots) (Constructor) |
New HeightLinear interpolator. Parameters: `knots` - The points with known height (`LatLon`s). Raises: `HeightError` - Insufficient number of knots or invalid knot. `ImportError` - No `numpy` or no `scipy` module. `SciPyError` - A `scipy.interpolate.interp2d` issue. `SciPyWarning` - A `scipy.interpolate.interp2d` warning as exception. 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 or invalide lli. `SciPyError` - A `scipy.interpolate.interp2d` issue. `SciPyWarning` - A `scipy.interpolate.interp2d` warning as exception. 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. `SciPyError` - A `scipy.interpolate.interp2d` issue. `SciPyWarning` - A `scipy.interpolate.interp2d` warning as exception. Overrides: HeightCubic.height