Package pygeodesy :: Module geoids :: Class GeoidG2012B
[frames] | no frames]

Class GeoidG2012B

     object --+            
              |            
   named._Named --+        
                  |        
heights._HeightBase --+    
                      |    
             _GeoidBase --+
                          |
                         GeoidG2012B

Geoid height interpolator for GEOID12B Model grids CONUS, Alaska, Hawaii, Guam and Northern Mariana Islands, Puerto Rico and U.S. Virgin Islands and American Samoa based on SciPy RectBivariateSpline or interp2d interpolation.

Use any of the binary le (little endian) or be (big endian) g2012b*.bin grid files.

Instance Methods
 
__init__(self, g2012b_bin, crop=None, datum=None, kind=3, name='', smooth=0)
New GeoidG2012B interpolator.
 
__call__(self, *llis)
Interpolate the geoid height for one or several locations.
 
height(self, lats, lons)
Interpolate the geoid height for one or several lat-/longitudes.

Inherited from _GeoidBase: __repr__, __str__, center, highest, lowerleft, lowerright, lowest, outside, toStr, upperleft, upperright

Inherited from named._Named: _dot_, attrs, classof, copy, toRepr, toStr2

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Properties

Inherited from _GeoidBase: cropped, dtype, endian, hits, kind, knots, mean, nBytes, name, numpy, pgm, scipy, sizeB, smooth, stdev

Inherited from heights._HeightBase: adjust, datum, kmin, wrap

Inherited from named._Named: classname, classnaming, named, named2

Inherited from object: __class__

Method Details

__init__ (self, g2012b_bin, crop=None, datum=None, kind=3, name='', smooth=0)
(Constructor)

 

New GeoidG2012B interpolator.

Arguments:
  • g2012b_bin - A GEOID12B grid file name (.bin).
  • crop - Optional crop box, not supported (None).
  • datum - Optional grid datum (Datum), default WGS84.
  • kind - scipy.interpolate order (int), use 1..5 for RectBivariateSpline, -2 for interp2d linear, -3 for interp2d cubic or -5 for interp2d quintic.
  • name - Optional geoid name (str).
  • smooth - Smoothing factor for RectBivariateSpline only (int).
Raises:
  • GeoidError - G2012B grid file g2012b_bin issue, non-None crop or invalid kind or smooth.
  • ImportError - Package numpy or scipy not found or not installed.
  • SciPyError - A RectBivariateSpline or inter2d issue.
  • SciPyWarning - A RectBivariateSpline or inter2d warning as exception.
Overrides: object.__init__

__call__ (self, *llis)
(Call operator)

 

Interpolate the geoid height for one or several locations.

Arguments:
  • llis - The location or locations (LatLon, ... or LatLons).
Returns:
A single interpolated geoid height (float) or a list or tuple of interpolated geoid heights (floats).
Raises:
  • GeoidError - Insufficient number of llis or an invalid lli.
  • RangeError - An lli is outside this geoid's lat- or longitude range.
  • SciPyError - A scipy.interpolate.inter2d or -.RectBivariateSpline issue.
  • SciPyWarning - A scipy.interpolate.inter2d or -.RectBivariateSpline warning as exception.
Overrides: heights._HeightBase.__call__

height (self, lats, lons)

 

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

Arguments:
  • lats - Latitude or latitudes (degrees or degreess).
  • lons - Longitude or longitudes (degrees or degreess).
Returns:
A single interpolated geoid height (float) or a list of interpolated geoid heights (floats).
Raises:
  • GeoidError - Insufficient or non-matching number of lats and lons.
  • RangeError - A lat or lon is outside this geoid's lat- or longitude range.
  • SciPyError - A scipy.interpolate.inter2d or -.RectBivariateSpline issue.
  • SciPyWarning - A scipy.interpolate.inter2d or -.RectBivariateSpline warning as exception.
Overrides: _GeoidBase.height