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

# Class HeightSmoothBiSpline

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

Height interpolator using `SciPy` SmoothSphereBivariateSpline.

Instance Methods
__init__(self, knots, s=4, name=`'````'`) New HeightSmoothBiSpline 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`, `toStr`, `toStr2` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

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

Method Details

### __init__(self, knots, s=4, name=`'````'`) (Constructor) |
New HeightSmoothBiSpline interpolator. Parameters: `knots` - The points with known height (`LatLon`s). `s` - The spline smoothing factor (`4`). `name` - Optional height interpolator name (`str`). Raises: `HeightError` - Insufficient number of `knots` or invalid `knot` or `s`. `ImportError` - Package `numpy` or `scipy` not found or not installed. `SciPyError` - A `SmoothSphereBivariateSpline` issue. `SciPyWarning` - A `SmoothSphereBivariateSpline` 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 invalid `lli`. `SciPyError` - A `SmoothSphereBivariateSpline` issue. `SciPyWarning` - A `SmoothSphereBivariateSpline` 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 `SmoothSphereBivariateSpline` issue. `SciPyWarning` - A `SmoothSphereBivariateSpline` warning as exception.