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

Class _GeoidBase

     object --+        
              |        
   named._Named --+    
                  |    
heights._HeightBase --+
                      |
                     _GeoidBase
Known Subclasses:

(INTERNAL) Base class for Geoid...s.

Instance Methods
 
__init__(self, hs, p)
(INTERNAL) Set up the grid axes, the SciPy interpolator and several internal geoid attributes.
 
__call__(self, *llis)
Interpolate the geoid height for one or several locations.
 
__repr__(self)
repr(x)
 
__str__(self)
str(x)
 
center(self, LatLon=None)
Return the center location and height of this geoid.
 
height(self, lats, lons)
Interpolate the geoid height for one or several lat-/longitudes.
 
highest(self, LatLon=None)
Return the highest location and height of this geoid.
 
lowerleft(self, LatLon=None)
Return the lower-left location and height of this geoid.
 
lowerright(self, LatLon=None)
Return the lower-right location and height of this geoid.
 
lowest(self, LatLon=None)
Return the lowest location and height of this geoid.
 
outside(self, lat, lon)
Check whether a location is outside this geoid's lat-/longitude or crop range.
 
toStr(self, prec=3, sep=', ')
This geoid and all geoid attributes as a string.
 
upperleft(self, LatLon=None)
Return the upper-left location and height of this geoid.
 
upperright(self, LatLon=None)
Return the upper-right location and height of this geoid.

Inherited from named._Named: classof, copy, toStr2

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

Properties
  dtype
Get the grid scipy dtype (numpy.dtype).
  endian
Get the geoid endianess and dtype (str).
  hits
Get the number of cache hits (int or None).
  kind
Get the interpolator kind and order (int).
  knots
Get the number of grid knots (int).
  mean
Get the mean of this geoid's heights (float).
  name
Get the name of this geoid (str).
  nBytes
Get the grid in-memory size in bytes (int).
  numpy
Get the imported numpy version (str).
  scipy
Get the imported scipy version (str).
  sizeB
Get the geoid grid file size in bytes (int).
  smooth
Get the RectBivariateSpline smoothing (int).
  stdev
Get the standard deviation of this geoid's heights (float).

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

Inherited from object: __class__

Method Details

__init__(self, hs, p)
(Constructor)

 

(INTERNAL) Set up the grid axes, the SciPy interpolator and several internal geoid attributes.

Parameters:
  • hs - Grid knots with known height (numpy 2darray).
  • p - The slat, wlon, nlat, nlon, dlat, dlon and other geoid parameters (INTERNAL).
Raises:
  • GeoidError - Invalid kind.
  • SciPyError - A scipy.interpolate.inter2d or -.RectBivariateSpline issue.
  • SciPyWarning - A scipy.interpolate.inter2d or -.RectBivariateSpline warning as exception.
Overrides: object.__init__

__call__(self, *llis)
(Call operator)

 

Interpolate the geoid height for one or several locations.

Parameters:
  • 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__

__repr__(self)
(Representation operator)

 

repr(x)

Overrides: object.__repr__
(inherited documentation)

__str__(self)
(Informal representation operator)

 

str(x)

Overrides: object.__str__
(inherited documentation)

center(self, LatLon=None)

 

Return the center location and height of this geoid.

Parameters:
  • LatLon - Optional (sub-)class to return the location (LatLon) and height or None.
Returns:
A LatLon3Tuple(lat, lon, height) if LatLon is None or a LatLon instance with the lat-, longitude and height of the grid center location.

height(self, lats, lons)

 

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

Parameters:
  • 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.

highest(self, LatLon=None)

 

Return the highest location and height of this geoid.

Parameters:
  • LatLon - Optional (sub-)class to return the location (LatLon) and height or None.
Returns:
A LatLon3Tuple(lat, lon, height) if LatLon is None or a LatLon instance with the lat-, longitude and height of the highest grid location.

lowerleft(self, LatLon=None)

 

Return the lower-left location and height of this geoid.

Parameters:
  • LatLon - Optional (sub-)class to return the location (LatLon) and height or None.
Returns:
A LatLon3Tuple(lat, lon, height) if LatLon is None or a LatLon instance with the lat-, longitude and height of the lower-left, SW grid corner.

lowerright(self, LatLon=None)

 

Return the lower-right location and height of this geoid.

Parameters:
  • LatLon - Optional (sub-)class to return the location (LatLon) and height or None.
Returns:
A LatLon3Tuple(lat, lon, height) if LatLon is None or a LatLon instance with the lat-, longitude and height of the lower-right, SE grid corner.

lowest(self, LatLon=None)

 

Return the lowest location and height of this geoid.

Parameters:
  • LatLon - Optional (sub-)class to return the location (LatLon) and height or None.
Returns:
A LatLon3Tuple(lat, lon, height) if LatLon is None or a LatLon instance with the lat-, longitude and height of the lowest grid location.

outside(self, lat, lon)

 

Check whether a location is outside this geoid's lat-/longitude or crop range.

Parameters:
  • lat - The latitude (degrees).
  • lon - The longitude (degrees).
Returns:
A 1- or 2-character str if outside or an empty str if inside.

toStr(self, prec=3, sep=', ')

 

This geoid and all geoid attributes as a string.

Parameters:
  • prec - Optional number of decimal digits (0..9 or None for default). Trailing zero decimals are stripped for prec values of 1 and above, but kept for negative prec values.
  • sep - Optional separator (str).
Returns:
Geoid name and attributes (str).
Overrides: named._Named.toStr

upperleft(self, LatLon=None)

 

Return the upper-left location and height of this geoid.

Parameters:
  • LatLon - Optional (sub-)class to return the location (LatLon) and height or None.
Returns:
A LatLon3Tuple(lat, lon, height) if LatLon is None or a LatLon instance with the lat-, longitude and height of the upper-left, NW grid corner.

upperright(self, LatLon=None)

 

Return the upper-right location and height of this geoid.

Parameters:
  • LatLon - Optional (sub-)class to return the location (LatLon) and height or None.
Returns:
A LatLon3Tuple(lat, lon, height) if LatLon is None or a LatLon instance with the lat-, longitude and height of the upper-right, NE grid corner.

Property Details

dtype

Get the grid scipy dtype (numpy.dtype).

Get Method:
dtype(self) - Get the grid scipy dtype (numpy.dtype).
Set Method:
Read_Only(self, ignored) - Throws an AttributeError, always.

endian

Get the geoid endianess and dtype (str).

Get Method:
endian(self) - Get the geoid endianess and dtype (str).
Set Method:
Read_Only(self, ignored) - Throws an AttributeError, always.

hits

Get the number of cache hits (int or None).

Get Method:
hits(self) - Get the number of cache hits (int or None).
Set Method:
Read_Only(self, ignored) - Throws an AttributeError, always.

kind

Get the interpolator kind and order (int).

Get Method:
kind(self) - Get the interpolator kind and order (int).
Set Method:
Read_Only(self, ignored) - Throws an AttributeError, always.

knots

Get the number of grid knots (int).

Get Method:
knots(self) - Get the number of grid knots (int).
Set Method:
Read_Only(self, ignored) - Throws an AttributeError, always.

mean

Get the mean of this geoid's heights (float).

Get Method:
mean(self) - Get the mean of this geoid's heights (float).
Set Method:
Read_Only(self, ignored) - Throws an AttributeError, always.

name

Get the name of this geoid (str).

Get Method:
name(self) - Get the name of this geoid (str).
Set Method:
Read_Only(self, ignored) - Throws an AttributeError, always.

nBytes

Get the grid in-memory size in bytes (int).

Get Method:
nBytes(self) - Get the grid in-memory size in bytes (int).
Set Method:
Read_Only(self, ignored) - Throws an AttributeError, always.

numpy

Get the imported numpy version (str).

Get Method:
numpy(self) - Get the imported numpy version (str).
Set Method:
Read_Only(self, ignored) - Throws an AttributeError, always.

scipy

Get the imported scipy version (str).

Get Method:
scipy(self) - Get the imported scipy version (str).
Set Method:
Read_Only(self, ignored) - Throws an AttributeError, always.

sizeB

Get the geoid grid file size in bytes (int).

Get Method:
sizeB(self) - Get the geoid grid file size in bytes (int).
Set Method:
Read_Only(self, ignored) - Throws an AttributeError, always.

smooth

Get the RectBivariateSpline smoothing (int).

Get Method:
smooth(self) - Get the RectBivariateSpline smoothing (int).
Set Method:
Read_Only(self, ignored) - Throws an AttributeError, always.

stdev

Get the standard deviation of this geoid's heights (float).

Get Method:
stdev(self) - Get the standard deviation of this geoid's heights (float).
Set Method:
Read_Only(self, ignored) - Throws an AttributeError, always.