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

Class HeightSmoothBiSpline

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

Height interpolator using SciPy SmoothSphereBivariateSpline.

Instance Methods
 
__init__(self, knots, s=4, name='', **wrap)
New HeightSmoothBiSpline 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, s=4, name='', **wrap)
(Constructor)

 

New HeightSmoothBiSpline interpolator.

Arguments:
  • knots - The points with known height (LatLons).
  • s - The spline smoothing factor (scalar), default 4.
  • name - Optional name for this height interpolator (str).
  • wrap - If True, wrap or normalize the knots and any called llis and height lats and lons locations (bool).
Raises:
  • HeightError - Insufficient number of knots or an invalid knot or s.
  • ImportError - Package numpy or scipy not found or not installed.
  • SciPyError - A scipy SmoothSphereBivariateSpline issue.
  • SciPyWarning - A scipy SmoothSphereBivariateSpline 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 (LatLons), 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 (floats).
Raises:
  • SciPyError - A scipy SmoothSphereBivariateSpline issue.
  • SciPyWarning - A scipy SmoothSphereBivariateSpline warning as exception.
Overrides: _HeightsBase.__call__

See Also: Here for other details.

height (self, lats, lons, **wrap)

 

Interpolate the height for one or several lat-/longitudes.

Arguments:
  • lats - Latitude or latitudes (degrees or degreess).
  • lons - Longitude or longitudes (degrees or degreess).
  • 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 (floats).
Raises:
  • SciPyError - A scipy SmoothSphereBivariateSpline issue.
  • SciPyWarning - A scipy SmoothSphereBivariateSpline warning as exception.
Overrides: _HeightsBase.height

See Also: Here for other details.