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

# Class HeightCubic

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

Known Subclasses:
  - HeightLinear

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

Instance Methods
__init__(self, knots, name='', **wrap) New HeightCubic interpolator. |
__call__(self, *llis, **wrap) Interpolate the height for one or several locations. |
height(self, lats, lons, **wrap) 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 `_HeightsBase`: `numpy`, `scipy`, `scipy_interpolate` Inherited from `_HeightBase`: `datum`, `kmin`, `wrap` Inherited from `named._Named`: `classname`, `classnaming`, `iteration`, `name`, `named`, `named2`, `named3`, `named4`, `sizeof` Inherited from `object`: `__class__`

Method Details

### __init__ (self, knots, name='', **wrap) (Constructor) |
New HeightCubic interpolator. Arguments: `knots` - The points with known height (`LatLon`s). `name` - Optional name for this height interpolator (`str`). `wrap` - If `True`, wrap or normalize all `knots` and `llis` locations (`bool`). 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, **wrap) (Call operator) |
Interpolate the height for one or several locations. Arguments: `llis` - One or more locations (`LatLon`s), all positional. `wrap` - If `True`, wrap or normalize all `llis` locations (`bool`), overriding the `knots` setting. Returns: A single interpolated height (`float`) or a list or tuple of interpolated heights (`float`s). Raises: `SciPyError` - A `scipy.interpolate.interp2d` issue. `SciPyWarning` - A `scipy.interpolate.interp2d` warning as exception. Overrides: _HeightsBase.__call__ See Also: _HeightsBase.__call__ for details about `llis`, `wrap`, return values and other exceptions.

### height (self, lats, lons, **wrap) |
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). `wrap` - If `True`, wrap or normalize all `lats` and `lons` locationts (`bool`), overriding the `knots` setting. Returns: A single interpolated height (`float`) or a list of interpolated heights (`float`s). Raises: `SciPyError` - A `scipy.interpolate.interp2d` issue. `SciPyWarning` - A `scipy.interpolate.interp2d` warning as exception. Overrides: _HeightsBase.height See Also: _HeightsBase.height for details about `lats`, `lons`, `wrap`, return values and other exceptions.