Package pygeodesy3 :: Package elevations

Package elevations

Elevations: ellipsoidal, orthometric heights for (geodetic) LatLon points from geoid models, interpolations and web services.

Version: 23.12.18

Submodules
pygeodesy3.elevations.geoids: Geoid models and geoid height interpolations. pygeodesy3.elevations.heights: Height interpolations of `LatLon` points. pygeodesy3.elevations.webs: Web-services-based elevations and `CONUS` geoid heights.

Classes
	Elevation2Tuple 2-Tuple `(elevation, data_source)` in `meter` and `str`.
	GeoidError Geoid interpolator `Geoid...` or interpolation issue.
	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.
	GeoidHeight2Tuple 2-Tuple `(height, model_name)`, geoid `height` in `meter` and `model_name` as `str`.
	GeoidHeight5Tuple 5-Tuple `(lat, lon, egm84, egm96, egm2008)` for GeoidHeights.dat tests with the heights for 3 different EGM grids at `degrees90` and `degrees180` degrees (after converting `lon` from original `0 <= EasterLon <= 360`).
	GeoidKarney Geoid height interpolator for Karney's GeographicLib Earth Gravitational Model (EGM) geoid egm.pgm datasets using bilinear or cubic interpolation and caching in pure Python, transcoded from Karney*'s C++ class Geoid.
	GeoidPGM Geoid height interpolator for Karney's GeographicLib Earth Gravitational Model (EGM) geoid egm*.pgm datasets but based on `SciPy` RectBivariateSpline or interp2d interpolation.
	HeightCubic Height interpolator based on `SciPy` interp2d `kind='cubic'`.
	HeightError Height interpolator `Height...` or interpolation issue.
	HeightIDWcosineAndoyerLambert Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in `radians` from function pygeodesy3.cosineAndoyerLambert_.
	HeightIDWcosineForsytheAndoyerLambert Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in `radians` from function pygeodesy3.cosineForsytheAndoyerLambert_.
	HeightIDWcosineLaw Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in `radians` from function pygeodesy3.cosineLaw_.
	HeightIDWdistanceTo Height interpolator using Inverse Distance Weighting (IDW) and the distance from the points' `LatLon.distanceTo` method, conventionally in `meter`.
	HeightIDWequirectangular Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in `radians squared` like function pygeodesy3.equirectangular_.
	HeightIDWeuclidean Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in `radians` from function pygeodesy3.euclidean_.
	HeightIDWexact Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in `degrees` from method GeodesicExact`.Inverse`.
	HeightIDWflatLocal Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in `radians squared` like function pygeodesy3.flatLocal_/pygeodesy3.hubeny_.
	HeightIDWflatPolar Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in `radians` from function pygeodesy3.flatPolar_.
	HeightIDWhaversine Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in `radians` from function pygeodesy3.haversine_.
	HeightIDWhubeny Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in `radians squared` like function pygeodesy3.flatLocal_/pygeodesy3.hubeny_.
	HeightIDWkarney Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in `degrees` from Karney's geographiclib Geodesic Inverse method.
	HeightIDWthomas Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in `radians` from function pygeodesy3.thomas_.
	HeightIDWvincentys Height interpolator using Inverse Distance Weighting (IDW) and the angular distance in `radians` from function pygeodesy3.vincentys_.
	HeightLSQBiSpline Height interpolator using `SciPy` LSQSphereBivariateSpline.
	HeightLinear Height interpolator based on `SciPy` interp2d `kind='linear'`.
	HeightSmoothBiSpline Height interpolator using `SciPy` SmoothSphereBivariateSpline.
	PGMError Issue parsing or cropping an `egm*.pgm` geoid dataset.

Functions

egmGeoidHeights(GeoidHeights_dat)
Generate geoid egm*.pgm height tests from GeoidHeights.dat Test data for Geoids.

elevation2(lat, lon, timeout=2.0)
Get the geoid elevation at an NAD83 to NAVD88 location.

geoidHeight2(lat, lon, model=0, timeout=2.0)
Get the NAVD88 geoid height at an NAD83 location.

Variables
	__getattr__ = `_lazy_import_as(__name__)`

Function Details

egmGeoidHeights (GeoidHeights_dat)

Generate geoid egm*.pgm height tests from GeoidHeights.dat Test data for Geoids.

Arguments:

GeoidHeights_dat - The un-gz-ed GeoidHeights.dat file (str or file handle).

Returns:

For each test, yield a GeoidHeight5Tuple

(lat, lon, egm84, egm96, 
          egm2008)

Raises:

GeoidError - Invalid GeoidHeights_dat.

Note: Function egmGeoidHeights is used to test the geoids GeoidKarney and GeoidPGM, see PyGeodesy3 module test/testGeoids.py.

elevation2 (lat, lon, timeout=2.0)

Get the geoid elevation at an NAD83 to NAVD88 location.

Arguments:

lat - Latitude (degrees).
lon - Longitude (degrees).
timeout - Optional, query timeout (seconds).

Returns:

An Elevation2Tuple

(elevation, 
          data_source)

or (None, "error") in case of errors.

Raises:

ValueError - Invalid timeout.

Note: The returned elevation is None if lat or lon is invalid or outside the Conterminous US (CONUS), if conversion failed or if the query timed out. The "error" is the HTTP-, IO-, SSL- or other -Error as a string (str).

See Also: USGS Elevation Point Query Service, the FAQ, geoid.py, module geoids, classes GeoidG2012B, GeoidKarney and GeoidPGM.

geoidHeight2 (lat, lon, model=0, timeout=2.0)

Get the NAVD88 geoid height at an NAD83 location.

Arguments:

lat - Latitude (degrees).
lon - Longitude (degrees).
model - Optional, geoid model ID (int).
timeout - Optional, query timeout (seconds).

Returns:

An GeoidHeight2Tuple

(height, 
          model_name)

or (None, "error") in case of errors.

Raises:

ValueError - Invalid timeout.

Note: The returned height is None if lat or lon is invalid or outside the Conterminous US (CONUS), if the model was invalid, if conversion failed or if the query timed out. The "error" is the HTTP-, IO-, SSL-, URL- or other -Error as a string (str).

See Also: NOAA National Geodetic Survey, Geoid, USGS10mElev.py, module geoids, classes GeoidG2012B, GeoidKarney and GeoidPGM.