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

# Class HeightCubic

      object --+
               |
    named._Named --+
                   |
         _HeightBase --+
                       |
                      HeightCubic

Known Subclasses:
  - HeightLinear

Height interpolator based on `SciPy` interp2d `kind='cubic'`.

Instance Methods
__init__(self, knots, name=`'````'`) New HeightCubic 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__`, `_dot_`, `attrs`, `classof`, `copy`, `toRepr`, `toStr`, `toStr2` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
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, name=`'````'`) (Constructor) |
New HeightCubic interpolator. Arguments: `knots` - The points with known height (`LatLon`s). `name` - Optional name for this height interpolator (`str`). Raises: `HeightError` - Insufficient number of `knots` or invalid `knot`. `ImportError` - Package `numpy` or `scipy` not found or not installed. `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. 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` or an invalid `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. 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`. `SciPyError` - A `scipy.interpolate.interp2d` issue. `SciPyWarning` - A `scipy.interpolate.interp2d` warning as exception.