[ Module Hierarchy
| Class Hierarchy ]
Module Hierarchy
- pygeodesy: A pure Python implementation of geodesy tools for various
ellipsoidal and spherical earth models using precision
trigonometric, vector-based, elliptic and approximate methods for
geodetic (lat-/longitude) and geocentric (ECEF
cartesian) coordinates.
- pygeodesy.__main__: Print pygeodesy
version, etc.
- pygeodesy.albers: Classes AlbersEqualArea, AlbersEqualArea2, AlbersEqualArea4, AlbersEqualAreaCylindrical, AlbersEqualAreaNorth, AlbersEqualAreaSouth and AlbersError, a transcription of Charles
Karney's C++ class AlbersEqualArea.
- pygeodesy.azimuthal: Azimuthal projection classes Equidistant, EquidistantKarney, Gnomonic, GnomonicKarney, LambertEqualArea, Orthographic and Stereographic, classes AzimuthalError, Azimuthal7Tuple and functions equidistant and gnomonic.
- pygeodesy.basics: Basic definitions and functions.
- pygeodesy.cartesianBase: (INTERNAL) Base classes for elliposiodal, spherical and
N-/vectorial
Cartesian
s.
- pygeodesy.clipy: Functions to clip a path or polygon of
LatLon
points against a rectangular box or a (convex) clip region.
- pygeodesy.css: Cassini-Soldner projection classes CassiniSoldner, Css and CSSError
requiring Charles Karney's geographiclib Python package to be installed.
- pygeodesy.datums: Classes Datum and Transform and registries Datums
and Transforms, respectively.
- pygeodesy.deprecated: DEPRECATED classes, functions, etc.
- pygeodesy.dms: Functions to parse and format bearing, compass, lat- and longitudes
in various forms of degrees, minutes and seconds.
- pygeodesy.ecef: Geocentric conversions transcribed from Charles Karney's C++
class Geocentric into pure Python class EcefKarney, class EcefSudano based on John Sudano's paper, class EcefVeness transcribed from Chris Veness'
JavaScript classes LatLonEllipsoidal, Cartesian, class EcefYou
implementing Rey-Jer You's transformations and classes EcefFarrell22 and EcefFarrell22 from Jay A. Farrell's Table 2.1 and 2.2, page 29-30.
- pygeodesy.elevations: Functions to obtain elevations and geoid heights thru web services,
for (lat, lon) locations, currently limited to the Conterminous US (CONUS), see also module geoids, module
heights
classes and USGS10mElev.py.
- pygeodesy.ellipsoidalBase: (INTERNAL) Ellipsoidal base classes
CartesianEllipsoidalBase
and
LatLonEllipsoidalBase
and several ellipsoidal
functions, all used by .ellipsoidalKarney
,
.ellipsoidalNvector
or
.ellipsoidalVincenty
.
- pygeodesy.ellipsoidalKarney: Ellipsoidal geodetic (lat-/longitude) LatLon and geocentric (ECEF) Cartesian classes and functions areaOf, intersections2, isclockwise, nearestOn and perimeterOf, all requiring Charles Karney's
geographiclib Python package to be installed.
- pygeodesy.ellipsoidalNvector: Ellispdoidal, N-vector-based classes geodetic (lat-/longitude) LatLon, geocentric (ECEF) Cartesian, Ned and Nvector and functions meanOf.
- pygeodesy.ellipsoidalVincenty: Ellipsoidal Thaddeus Vincenty's geodetic (lat-/longitude) LatLon, geocentric (ECEF) Cartesian and VincentyError classes and functions areaOf, intersections2, nearestOn and perimeterOf.
- pygeodesy.ellipsoids: Classes a_f2Tuple, Ellipsoid and Ellipsoid2, an Ellipsoids registry and a dozen functions to
convert equatorial radius, polar radius,
eccentricities, flattenings and inverse
flattening.
- pygeodesy.elliptic: Elliptic integrals and functions transcribed from Charles
Karney's C++ class EllipticFunction into pure Python class Elliptic.
- pygeodesy.epsg: Classes Epsg and EPSGError and functions to encode
and decode2 European Petroleum Survey Group (EPSG) codes
from and to UTM and UPS zones.
- pygeodesy.errors: Error, exception classes and functions to format PyGeodesy errors,
including the setting of exception chaining in Python 3+.
- pygeodesy.etm: Classes ETMError and Etm, a pure
Python transcription of Charles Karney's C++ class TransverseMercatorExact, abbreviated as
TMExact
below.
- pygeodesy.fmath: Precision floating point functions, utilities and constants.
- pygeodesy.formy: Formulary of basic geodesy functions and approximations.
- pygeodesy.frechet: Classes Frechet, FrechetDegrees, FrechetRadians, FrechetCosineAndoyerLambert, FrechetCosineForsytheAndoyerLambert, FrechetCosineLaw, FrechetDistanceTo< FrechetEquirectangular, FrechetEuclidean, FrechetFlatLocal, FrechetFlatPolar, FrechetHaversine, FrechetHubeny, FrechetKarney, FrechetThomas and FrechetVincentys to compute discrete Fréchet distances between two sets of
LatLon
, NumPy
, tuples
or
other types of points.
- pygeodesy.gars: Classes Garef and GARSError and several functions to encode, decode
and inspect Global Area Reference System (GARS) references.
- pygeodesy.geohash: Classes Geohash and GeohashError and several functions to encode,
decode and inspect geohashes.
- pygeodesy.geoids: Classes GeoidG2012B, GeoidKarney and GeoidPGM to interpolate the height of various geoids at
LatLon
locations or separate lat-/longitudes using
different interpolation methods and geoid
model files.
- pygeodesy.hausdorff: Classes Hausdorff, HausdorffDegrees, HausdorffRadians, HausdorffCosineAndoyerLambert, HausdorffCosineForsytheAndoyerLambert, HausdorffCosineLaw, HausdorffDistanceTo, HausdorffEquirectangular, HausdorffEuclidean, HausdorffFlatLocal, HausdorffFlatPolar, HausdorffHaversine, HausdorffHubeny, HausdorffKarney, HausdorffThomas and HausdorffVincentys to compute Hausdorff distances between two sets of
LatLon
, NumPy
, tuples
or
other types of points.
- pygeodesy.heights: Classes HeightCubic, HeightIDWcosineAndoyerLambert, HeightIDWcosineForsytheAndoyerLambert, HeightIDWcosineLaw, HeightIDWdistanceTo, HeightIDWequirectangular, HeightIDWeuclidean, HeightIDWflatLocal, HeightIDWflatPolar, HeightIDWhaversine, HeightIDWhubeny, HeightIDWkarney, HeightIDWthomas, HeightIDWvincentys, HeightLinear, HeightLSQBiSpline and HeightSmoothBiSpline to interpolate the height of
LatLon
locations or separate lat-/longitudes from a
set of LatLon
points with known
heights.
- pygeodesy.interns: Single-instance floats and strings,
intern
'ed across
modules.
- pygeodesy.iters: Iterator classes LatLon2PsxyIter and PointsIter to iterate over iterables, lists, sets,
tuples, etc.
- pygeodesy.karney: Wrapper around Charles Karney's Python classes
Geodesic
and GeodesicLine
and
Math
functions AngDiff
,
AngNormalize
, LatFix
and sum
from Karney's geographiclib, Python package, provided that
package is installed.
- pygeodesy.latlonBase: (INTERNAL) base class LatLonBase for elliposiodal, spherical and
n-vectorial
LatLon
s.
- pygeodesy.lazily: Lazily import
pygeodesy
modules and attributes, based
on lazy_import from Brett Cannon's modutil.
- pygeodesy.lcc: Lambert conformal conic projection for 1- or 2-Standard Parallels
classes Conic, Conics registry, LCCError
and position class Lcc.
- pygeodesy.ltp: Local cartesian and local tangent plane classes LocalCartesian and Ltp, LocalError and Frustum.
- pygeodesy.ltpTuples: Local coordinate classes XyzLocal, Enu, Ned and
Aer
and local coordinate tuples Local6Tuple, Xyz4Tuple, Enu4Tuple, Ned4Tuple, Aer4Tuple and Footprint5Tuple.
- pygeodesy.mgrs: Military Grid Reference System (MGRS/NATO) classes Mgrs and MGRSError and functions parseMGRS and toMgrs.
- pygeodesy.named: (INTERNAL) Classes
_Named
, _NamedDict
and
_NamedTuple
, all with nameable instances and several
subclasses thereof.
- pygeodesy.namedTuples: Tuples returned by
pygeodesy
functions and class
methods are all instances of some Named...Tuple
class,
all sub-classes of _NamedTuple
defined in
pygeodesy.named
.
- pygeodesy.nvectorBase: (INTERNAL) Base class LatLonNvectorBase for
n-vectorial
ellipsoidal and spherical LatLon
s, class NvectorBase for Cartesian
s and
function sumOf.
- pygeodesy.osgr: Ordinance Survey Grid References (OSGR) classes Osgr an OSGRError and functions parseOSGR and toOsgr.
- pygeodesy.points: Functions to handle collections and sequences of
LatLon
points specified as 2-d NumPy,
arrays
or tuples as LatLon
or as
pseudo-x/-y
pairs.
- pygeodesy.props: Im-/mutable, caching or memoizing properties and decorators for
DeprecationWarning
s.
- pygeodesy.simplify: Seven functions to simplify or linearize a path of
LatLon
points.
- pygeodesy.sphericalBase: (INTERNAL) Spherical base classes
CartesianSphericalBase
and
LatLonSphericalBase
used by
.sphericalNvector
or
.sphericalTrigonometry
.
- pygeodesy.sphericalNvector: N-vector-based classes geodetic (lat-/longitude) LatLon, geocentric (ECEF) Cartesian and Nvector and functions areaOf, intersection, meanOf, nearestOn3, perimeterOf, sumOf, triangulate and trilaterate, all spherical.
- pygeodesy.sphericalTrigonometry: Trigonometric classes geodetic (lat-/longitude) LatLon and geocentric (ECEF) Cartesian and functions areaOf, intersection, intersections2, isPoleEnclosedBy, meanOf, nearestOn3 and perimeterOf, all spherical.
- pygeodesy.streprs: Floating point and other formatting utilities.
- pygeodesy.trf: Terrestrial Reference Frame (TRF) classes RefFrame,
registry RefFrames and TRFError.
- pygeodesy.units: Sub-classes
Float
, Int
and
Str
from basic float
, int
respectively str
to named units as Degrees,
Feet, Meter, Radians,
etc.
- pygeodesy.ups: Universal Polar Stereographic (UPS) classes Ups and UPSError
and functions parseUPS5, toUps8 and
upsZoneBand5.
- pygeodesy.utily: Geometric and other utility functions and constants.
- pygeodesy.utm: Universal Transverse Mercator (UTM) classes Utm and UTMError
and functions parseUTM5, toUtm8 and
utmZoneBand5.
- pygeodesy.utmups: Functions parseUTMUPS5, toUtmUps8, UtmUps
and utmupsZoneBand5 to handle both Universal
Transverse Mercator (UTM) and Universal Polar Stereographic (UPS) coordinates.
- pygeodesy.utmupsBase: (INTERNAL) Base class
UtmUpsBase
and private functions
for the UTM, UPS, Mgrs and Epsg classes/modules.
- pygeodesy.vector3d: Generic 3-D vector base class Vector3d, class VectorError and functions intersections2, iscolinearWith, nearestOn, parse3d, sumOf
and trilaterate3d2.
- pygeodesy.webmercator: Web Mercator (WM) classes Wm and
WebMercatorError and functions parseWM and toWm.
- pygeodesy.wgrs: Classes Georef and WGRSError and several functions to encode, decode
and inspect World Geographic Reference System (WGRS)
references.