Module Hierarchy

• pygeodesy3: A pure Python implementation of geodesy tools for various ellipsoidal and spherical earth models using precision trigonometric, vector-based, exact, elliptic, iterative and approximate methods for geodetic (lat-/longitude), geocentric (ECEF cartesian) and certain triaxial ellipsoidal coordinates and supported only on Python 3.7 and newer.
  • pygeodesy3.Base
    • pygeodesy3.Base.cartesian: (INTERNAL) Private CartesianBase class for elliposiodal, spherical and N-/vectorial Cartesians and public functions rtp2xyz, rtp2xyz_, xyz2rtp and xyz2rtp_.
    • pygeodesy3.Base.karney: Wrapper around several geomath.Math functions from Karney's Python package geographiclib, provided that package is installed.
    • pygeodesy3.Base.latlon: (INTERNAL) Base class LatLonBase for all elliposiodal, spherical and N-vectorial LatLon classes.
    • pygeodesy3.Base.nvector: (INTERNAL) Private elliposiodal and spherical Nvector base classes LatLonNvectorBase and NvectorBase and function sumOf.
    • pygeodesy3.Base.solve: (INTERNAL) Private base classes for pygeodesy3.geodesic.solve and pygeodesy3.rhumb.solve.
    • pygeodesy3.Base.units: Basic Float, Int and String units classes.
    • pygeodesy3.Base.utmups: (INTERNAL) Private class UtmUpsBase, functions and constants for epsg, etm, mgrs, ups and utm.
    • pygeodesy3.Base.vector3d: (INTERNAL) Private, 3-D vector base class Vector3dBase.
  • pygeodesy3.__main__: Print pygeodesy3 version, etc.
  • pygeodesy3.basics: Some, basic definitions, functions and dependencies.
  • pygeodesy3.constants: Single-instance float and int constants across pygeodesy3 modules and related functions pygeodesy3.float_, pygeodesy3.isclose, pygeodesy3.isfinite, pygeodesy3.isinf, pygeodesy3.isint0, pygeodesy3.isnan, pygeodesy3.isnear0, pygeodesy3.isnear1, pygeodesy3.isnear90, pygeodesy3.isneg0, pygeodesy3.isninf, pygeodesy3.isnon0 and pygeodesy3.remainder.
  • pygeodesy3.deprecated: DEPRECATED classes, constants, functions, interns, methods, etc.
  • pygeodesy3.distances: Classes and functions to compute various distances.
    • pygeodesy3.distances.formy: Formulary of basic geodesy functions and approximations.
    • pygeodesy3.distances.frechet: Fréchet distances.
    • pygeodesy3.distances.hausdorff: Hausdorff distances.
    • pygeodesy3.distances.resections: 3-Point resection functions cassini, collins5, pierlot, pierlotx and tienstra7, survey functions snellius3 and wildberger3 and triangle functions triAngle, triAngle5, triSide, triSide2 and triSide4.
  • pygeodesy3.earth: Classes and functions to model the earth by datum, bi- or triaxial ellipsoid or sphere.
    • pygeodesy3.earth.datums: Datums and transformations thereof.
    • pygeodesy3.earth.ecef: Geocentric Earth-Centered, Earth-Fixed (ECEF) coordinates.
    • pygeodesy3.earth.ellipsoids: Ellipsoidal and spherical earth models.
    • pygeodesy3.earth.trf: Veness' Terrestrial Reference Frames (TRF).
    • pygeodesy3.earth.triaxials: Triaxal ellipsoid classes ordered Triaxial and unordered Triaxial_ and Jacobi conformal projections JacobiConformal and JacobiConformalSpherical, transcoded from Charles Karney's C++ class JacobiConformal to pure Python and miscellaneous classes BetaOmega2Tuple, BetaOmega3Tuple, Jacobi2Tuple and TriaxialError.
  • pygeodesy3.elevations: Elevations: ellipsoidal, orthometric heights for (geodetic) LatLon points from geoid models, interpolations and web services.
    • 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.
  • pygeodesy3.ellipsoidal
    • pygeodesy3.ellipsoidal.Base: (INTERNAL) Private ellipsoidal base classes CartesianEllipsoidalBase and LatLonEllipsoidalBase.
    • pygeodesy3.ellipsoidal.BaseDI: (INTERNAL) Private, ellipsoidal Direct/Inverse geodesy base class LatLonEllipsoidalBaseDI and functions.
    • pygeodesy3.ellipsoidal.exact: Exact ellipsoidal geodesy using Karney's Exact Geodesic.
    • pygeodesy3.ellipsoidal.karney: Ellipsoidal, Karney-based geodesy.
    • pygeodesy3.ellipsoidal.nvector: Ellipsoidal, N-vector-based geodesy.
    • pygeodesy3.ellipsoidal.solve: Exact ellipsoidal geodesy, intended for testing purposes only.
    • pygeodesy3.ellipsoidal.vincenty: Ellipsoidal, Vincenty-based geodesy.
  • pygeodesy3.geodesic: Pure Python versions of three Karney geodesics, C++ class GeodesicExact, GeodSolve utility and Python package geographiclib, provided that package is installed.
    • pygeodesy3.geodesic.exact: A pure Python version of Karney's C++ classes GeodesicExact and GeodesicLineExact.
      • pygeodesy3.geodesic.exact._C4_24: A Python version of part of Karney's C++ module GeodesicExactC4.
      • pygeodesy3.geodesic.exact._C4_27: A Python version of part of Karney's C++ module GeodesicExactC4.
      • pygeodesy3.geodesic.exact._C4_30: A Python version of part of Karney's C++ module GeodesicExactC4.
      • pygeodesy3.geodesic.exact.__main__: Print geodesic.exact version, etc.
      • pygeodesy3.geodesic.exact.gx: A pure Python version of Karney's C++ class GeodesicExact.
      • pygeodesy3.geodesic.exact.gxBases: (INTERNAL) Private geodesic.wrap base class, functions and constants.
      • pygeodesy3.geodesic.exact.gxarea: Slightly enhanced versions of classes PolygonArea and Accumulator from Karney's Python geographiclib.
      • pygeodesy3.geodesic.exact.gxline: A pure Python version of Karney's C++ class GeodesicLineExact.
    • pygeodesy3.geodesic.solve: Wrapper to invoke Karney's GeodSolve utility as an (exact) geodesic, but intended for testing purposes only.
    • pygeodesy3.geodesic.wrap: Wrapper around Python classes geodesic.Geodesic and geodesicline.GeodesicLine from Karney's Python package geographiclib, provided that package is installed.
  • pygeodesy3.grids: Various grids and de-/encodings.
    • pygeodesy3.grids.epsg: European Petroleum Survey Group (EPSG) en-/decoding.
    • pygeodesy3.grids.gars: Global Area Reference System (GARS) en-/decoding.
    • pygeodesy3.grids.geohash: Geohash en-/decoding.
    • pygeodesy3.grids.mgrs: Military Grid Reference System (MGRS/NATO) references.
    • pygeodesy3.grids.osgr: Ordnance Survey Grid References (OSGR) references on the UK National Grid.
    • pygeodesy3.grids.wgrs: World Geographic Reference System (WGRS) en-/decoding.
  • pygeodesy3.interns: Single string constants, intern'ed across pygeodesy3 modules and function pygeodesy3.machine.
  • pygeodesy3.lazily: Lazily import pygeodesy3 modules and attributes, based on lazy_import from Brett Cannon's modutil.
  • pygeodesy3.maths: Precision mathematical classes and functions.
    • pygeodesy3.maths.auxilats: Classes AuxAngle, AuxDLat, AuxDST and AuxLat transcoded to Python from Karney's C++ class AuxAngle, DAuxLatitude, DST, repectively AuxLatitude all in GeographicLib version 2.2+.
      • pygeodesy3.maths.auxilats._CX_4: Coeficients for _AUXLATITUDE_ORDER 4 from Karney's C++ class AuxLatitude trancoded to a double, uniquified Python dict[auxout][auxin].
      • pygeodesy3.maths.auxilats._CX_6: Coeficients for _AUXLATITUDE_ORDER 6 from Karney's C++ class AuxLatitude trancoded to a double, uniquified Python dict[auxout][auxin].
      • pygeodesy3.maths.auxilats._CX_8: Coeficients for _AUXLATITUDE_ORDER 8 from Karney's C++ class AuxLatitude trancoded to a double, uniquified Python dict[auxout][auxin].
      • pygeodesy3.maths.auxilats.__main__: Print maths.auxilats version, etc.
      • pygeodesy3.maths.auxilats.auxAngle: (INTERNAL) Auxiliary latitudes' base classes, constants and functions.
      • pygeodesy3.maths.auxilats.auxDLat: Class AuxDLat transcoded to Python from Karney's C++ class DAuxLatitude in GeographicLib version 2.2+.
      • pygeodesy3.maths.auxilats.auxDST: Discrete Sine Transforms (AuxDST) in Python, transcoded from Karney's C++ class DST in GeographicLib version 2.2+.
      • pygeodesy3.maths.auxilats.auxLat: Class AuxLat transcoded to Python from Karney's C++ class AuxLatitude in GeographicLib version 2.2+.
      • pygeodesy3.maths.auxilats.auxily: (INTERNAL) Auxiliary latitudes' classes, constants and functions.
    • pygeodesy3.maths.elliptic: Karney's elliptic functions and integrals.
    • pygeodesy3.maths.fmath: Utilities using precision floating point summation.
    • pygeodesy3.maths.fstats: Classes for running statistics and regressions based on pygeodesy3.Fsum, precision floating point summation.
    • pygeodesy3.maths.fsums: Class Fsum for precision floating point summation and running summation based on, respectively similar to Python's math.fsum.
    • pygeodesy3.maths.umath: Various mostly mathematical, utility functions.
    • pygeodesy3.maths.vector2d: 2- or 3-D vectorial functions circin6, circum3, circum4_, iscolinearWith, meeus2, nearestOn, radii11 and soddy4.
    • pygeodesy3.maths.vector3d: Extended 3-D vector class Vector3d and functions.
  • pygeodesy3.miscs: Miscellaneous classes and functions.
    • pygeodesy3.miscs.dms: Parsers and formatters of angles in degrees, minutes and seconds or radians.
    • pygeodesy3.miscs.errors: Errors, exceptions, exception formatting and exception chaining.
    • pygeodesy3.miscs.iters: Iterators with options.
    • pygeodesy3.miscs.named: (INTERNAL) Nameable class instances.
    • pygeodesy3.miscs.namedTuples: Named tuples.
    • pygeodesy3.miscs.props: Mutable, immutable and caching/memoizing properties and deprecation decorators.
    • pygeodesy3.miscs.streprs: Floating point and other formatting utilities.
    • pygeodesy3.miscs.units: Various units, all sub-classes of Float, Int and Str from basic float, int respectively str to named units as Degrees, Feet, Meter, Radians, etc.
  • pygeodesy3.polygonal: Classes and functions for operations on polygons or polylines, open or closed lists of points.
    • pygeodesy3.polygonal.booleans: Boolean operations on composite polygons and clips.
    • pygeodesy3.polygonal.clipy: Clip a path or polygon of LatLon points against a rectangular box or an arbitrary (convex) region.
    • pygeodesy3.polygonal.points: Utilities for point lists, tuples, etc.
    • pygeodesy3.polygonal.simplify: Simplify or linearize a path.
  • pygeodesy3.projections: Various earth projections.
    • pygeodesy3.projections.albers: Albers Equal-Area projections.
    • pygeodesy3.projections.azimuthal: Equidistant, Equal-Area, and other Azimuthal projections.
    • pygeodesy3.projections.css: Cassini-Soldner (CSS) projection.
    • pygeodesy3.projections.etm: A pure Python version of Karney's Exact Transverse Mercator (ETM) projection.
    • pygeodesy3.projections.ktm: A pure Python version of Karney's C++ class TransverseMercator based on Krüger series.
    • pygeodesy3.projections.lcc: Lambert Conformal Conic (LCC) projection.
    • pygeodesy3.projections.ltp: Local Tangent Plane (LTP) and local cartesian coordinates.
    • pygeodesy3.projections.ltpTuples: Named, Local Tangent Plane (LTP) tuples.
    • pygeodesy3.projections.ups: Karney's Universal Polar Stereographic (UPS) projection.
    • pygeodesy3.projections.utm: Veness' Universal Transverse Mercator (UTM) projection.
    • pygeodesy3.projections.utmups: Karney's UTM and UPS utilities.
    • pygeodesy3.projections.webmercator: Web Mercator (WM) projection.
  • pygeodesy3.rhumb: Package of lazily imported rhumb modules rhumb.aux_, rhumb.ekx and rhumb.solve.
    • pygeodesy3.rhumb.Bases: (INTERNAL) base classes RhumbBase and RhumbLineBase, pure Python version of Karney's C++ classes Rhumb and RhumbLine from GeographicLib versions 2.0 and 2.2 and Karney's C++ example Rhumb intersect.
    • pygeodesy3.rhumb.aux_: A pure Python version of Karney's Auxiliary Latitudes, C++ classes Rhumb and RhumbLine from GeographicLib version 2.2+ renamed to RhumbAux respectively RhumbLineAux.
    • pygeodesy3.rhumb.ekx: A pure Python version of Karney's elliptic functions, Krüger series expansion, C++ classes Rhumb and and RhumbLine from GeographicLib version 2.0, kept for backward compatibility.
    • pygeodesy3.rhumb.solve: Wrapper to invoke Karney's RhumbSolve utility as an (exact) rhumb or rhumb line from either GeographicLib 2.0 or 2.2+.
  • pygeodesy3.spherical
    • pygeodesy3.spherical.Base: (INTERNAL) Private spherical base classes CartesianSphericalBase and LatLonSphericalBase for spherical.nvector and c{spherical.trigonometry}.
    • pygeodesy3.spherical.nvector: Spherical, N-vector-based geodesy.
    • pygeodesy3.spherical.trigonometry: Spherical, trigonometry-based geodesy.