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

# Class _HeightsBase

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

Known Subclasses:
  - geoids._GeoidBase
  - , HeightCubic
  - , HeightLSQBiSpline
  - , HeightSmoothBiSpline

(INTERNAL) Interpolator base class.

Instance Methods
__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__`, `__init__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
| numpy Get the `numpy` module or `None`.
| scipy Get the `scipy` module or `None`.
| scipy_interpolate Get the `scipy.interpolate` module or `None`.
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

### __call__ (self, *llis, **wrap) (Call operator) |
Interpolate the height for one or several locations. Must be overloaded. 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: `HeightError` - Insufficient number of `llis` or an invalid `lli`. `SciPyError` - A `scipy` issue. `SciPyWarning` - A `scipy` warning as exception.

### height (self, lats, lons, **wrap) |
Interpolate the height for one or several lat-/longitudes. Must be overloaded. 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: `HeightError` - Insufficient or non-matching number of `lats` and `lons`. `SciPyError` - A `scipy` issue. `SciPyWarning` - A `scipy` warning as exception.

Property Details

### numpy Get the `numpy` module or `None`. Get method: numpy(self) - Get the `numpy` module or `None`. Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### scipy Get the `scipy` module or `None`. Get method: scipy(self) - Get the `scipy` module or `None`. Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### scipy_interpolate Get the `scipy.interpolate` module or `None`. Get method: scipy_interpolate(self) - Get the `scipy.interpolate` module or `None`. Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.