[frames] | no frames]

[ Module Hierarchy | Class Hierarchy ]

# Class Hierarchy

- object: The most base type
  - exceptions.BaseException: Common base class for all exceptions
    - exceptions.Exception: Common base class for all non-exit exceptions.
      - exceptions.StandardError: Base class for all standard Python exceptions that do not represent interpreter exiting.
        - exceptions.ImportError: Import can't find module, or can't find name in module.
          - pygeodesy.lazily.LazyImportError: Lazy import is not supported, disabled or failed some other way.
        - exceptions.ValueError: Inappropriate argument value (of correct type).
          - pygeodesy.vector3d.CrossError: Error raised for zero or near-zero vectorial cross products, occurring for coincident or colinear points, paths or bearings.
          - pygeodesy.heights.HeightError: Height interpolator or interpolation error.
            - pygeodesy.geoids.GeoidError: Geoid interpolator or interpolation error.
              - pygeodesy.geoids.PGMError: Error parsing or cropping an `egm*.pgm` geoid dataset.
            - pygeodesy.heights.SciPyError: Error raised for `SciPy` errors.
            - pygeodesy.heights.SciPyWarning: Exception thrown for `SciPy` warnings.
          - pygeodesy.utily.LimitError: Error raised for lat- or longitudinal deltas exceeding the limit in functions equirectangular and equirectangular_.
          - pygeodesy.dms.RangeError: Error raised for lat- or longitude values outside the clip, clipLat, clipLon or limit range in function clipDMS, parse3llh, parseDMS or parseDMS2.
          - pygeodesy.utm.UTMError: UTM parse or other error.
          - pygeodesy.ellipsoidalVincenty.VincentyError: Error raised from Vincenty's direct and inverse methods for coincident points or lack of convergence.
  - _abcoll.Container
    - _abcoll.Sequence: All the operations on a read-only sequence.
      - pygeodesy.points._Basequence: (INTERNAL) Base class.
        - pygeodesy.points.LatLon2psxy: Wrapper for `LatLon` points as "on-the-fly" pseudo-xy coordinates.
        - pygeodesy.points._Array2LatLon: Base class for Numpy2LatLon or Tuple2LatLon.
          - pygeodesy.points.Numpy2LatLon: Wrapper for `NumPy` arrays as "on-the-fly" `LatLon` points.
          - pygeodesy.points.Tuple2LatLon: Wrapper for tuple sequences as "on-the-fly" `LatLon` points.
  - pygeodesy.fmath.Fsum: Precision summation similar to standard Python function `math.fsum`.
    - pygeodesy.fmath.Fdot: Precision dot product.
    - pygeodesy.fmath.Fhorner: Precision polynomial evaluation using the Horner form.
    - pygeodesy.fmath.Fpolynomial: Precision polynomial evaluation.
  - _abcoll.Iterable
    - _abcoll.Sequence: All the operations on a read-only sequence.
      - pygeodesy.points._Basequence: (INTERNAL) Base class.
        - pygeodesy.points.LatLon2psxy: Wrapper for `LatLon` points as "on-the-fly" pseudo-xy coordinates.
        - pygeodesy.points._Array2LatLon: Base class for Numpy2LatLon or Tuple2LatLon.
          - pygeodesy.points.Numpy2LatLon: Wrapper for `NumPy` arrays as "on-the-fly" `LatLon` points.
          - pygeodesy.points.Tuple2LatLon: Wrapper for tuple sequences as "on-the-fly" `LatLon` points.
  - pygeodesy.points.LatLon_: Low-overhead `LatLon` class for Numpy2LatLon and Tuple2LatLon.
  - _abcoll.Sized
    - _abcoll.Sequence: All the operations on a read-only sequence.
      - pygeodesy.points._Basequence: (INTERNAL) Base class.
        - pygeodesy.points.LatLon2psxy: Wrapper for `LatLon` points as "on-the-fly" pseudo-xy coordinates.
        - pygeodesy.points._Array2LatLon: Base class for Numpy2LatLon or Tuple2LatLon.
          - pygeodesy.points.Numpy2LatLon: Wrapper for `NumPy` arrays as "on-the-fly" `LatLon` points.
          - pygeodesy.points.Tuple2LatLon: Wrapper for tuple sequences as "on-the-fly" `LatLon` points.
  - pygeodesy.points._Basequence: (INTERNAL) Base class.
    - pygeodesy.points.LatLon2psxy: Wrapper for `LatLon` points as "on-the-fly" pseudo-xy coordinates.
    - pygeodesy.points._Array2LatLon: Base class for Numpy2LatLon or Tuple2LatLon.
      - pygeodesy.points.Numpy2LatLon: Wrapper for `NumPy` arrays as "on-the-fly" `LatLon` points.
      - pygeodesy.points.Tuple2LatLon: Wrapper for tuple sequences as "on-the-fly" `LatLon` points.
  - pygeodesy.heights._HeightBase: Interpolator base class.
    - pygeodesy.heights.HeightCubic: Height interpolator based on `SciPy` interp2d `kind='cubic'`.
      - pygeodesy.heights.HeightLinear: Height interpolator based on `SciPy` interp2d `kind='linear]`.
    - pygeodesy.heights.HeightLSQBiSpline: Height interpolator using `SciPy` LSQSphereBivariateSpline.
    - pygeodesy.heights.HeightSmoothBiSpline: Height interpolator using `SciPy` SmoothSphereBivariateSpline.
    - pygeodesy.geoids._GeoidBase: (INTERNAL) Base class for `Geoid...`s.
      - pygeodesy.geoids.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.
      - pygeodesy.geoids.GeoidKarney: Geoid height interpolator for Charles Karney's GeographicLib Earth Gravitational Model (EGM) geoid egm*.pgm datasets using bilinear or cubic interpolation and caching in pure Python transcribed from Karney's C++ class Geoid.
      - pygeodesy.geoids.GeoidPGM: Geoid height interpolator for Charles Karney's GeographicLib Earth Gravitational Model (EGM) geoid egm*.pgm datasets but based on `SciPy` RectBivariateSpline or interp2d interpolation.
    - pygeodesy.heights._HeightIDW: Base class for Inverse Distance Weighting (IDW) height interpolators.
      - pygeodesy.heights.HeightIDW: Height interpolator using Inverse Distance Weighting (IDW) and the angular `Euclidean` distance from function euclidean_.
      - pygeodesy.heights.HeightIDW2: Height interpolator using Inverse Distance Weighting (IDW) and the `equirectangular` distance (in radians squared) like function equirectangular_.
      - pygeodesy.heights.HeightIDW3: Height interpolator using Inverse Distance Weighting (IDW) and the angular `Haversine` distance from function haversine_.
  - pygeodesy.bases._Named: (INTERNAL) Base class for named objects.
    - pygeodesy.gars.Garef: Garef class, sub-class of `str`.
    - pygeodesy.geohash.Geohash: Geohash class, sub-class of `str`.
    - pygeodesy.wgrs.Georef: Georef class, sub-class of `str`.
    - pygeodesy.ellipsoidalNvector.Ned: North-Eeast-Down (NED), also known as Local Tangent Plane (LTP), is a vector in the local coordinate frame of a body.
    - pygeodesy.bases._Based: (INTERNAL) Base class with name.
      - pygeodesy.css.CassiniSoldner: A Python version of Charles Karney's CassiniSoldner C++ class.
      - pygeodesy.css.Css: Cassini-Soldner East-/Northing location.
      - pygeodesy.bases.LatLonHeightBase: (INTERNAL) Base class for `LatLon` points on spherical or ellipsiodal earth models.
        - pygeodesy.ellipsoidalBase.LatLonEllipsoidalBase: (INTERNAL) Base class for ellipsoidal `LatLon`.
          - pygeodesy.ellipsoidalKarney.LatLon: An ellipsoidal LatLon similar to ellipsoidalVincenty.LatLon but using Charles F. F. Karney's Python GeographicLib to compute the geodesic distance, initial and final bearing (azimuths) between two given points or the destination point given a start point and an initial bearing.
          - pygeodesy.ellipsoidalNvector.LatLon: An n-vector-based ellipsoidal LatLon point.
          - pygeodesy.ellipsoidalVincenty.LatLon: Using the formulae devised by Thaddeus Vincenty (1975) with an ellipsoidal model of the earth to compute the geodesic distance and bearings between two given points or the destination point given an start point and initial bearing.
        - pygeodesy.nvector.LatLonNvectorBase: (INTERNAL) Base class for n-vector-based ellipsoidal and spherical `LatLon` classes.
          - pygeodesy.ellipsoidalNvector.LatLon: An n-vector-based ellipsoidal LatLon point.
          - pygeodesy.sphericalNvector.LatLon: New n-vector based point on spherical earth model.
        - pygeodesy.sphericalBase.LatLonSphericalBase: (INTERNAL) Base class for spherical `LatLon`.
          - pygeodesy.sphericalNvector.LatLon: New n-vector based point on spherical earth model.
          - pygeodesy.sphericalTrigonometry.LatLon: New point on spherical model earth model.
      - pygeodesy.lcc.Lcc: Lambert conformal conic East-/Northing location.
      - pygeodesy.mgrs.Mgrs: Military Grid Reference System (MGRS/NATO) references, with method to convert to UTM coordinates.
      - pygeodesy.osgr.Osgr: Ordinance Survey Grid References (OSGR) coordinate.
      - pygeodesy.utm.Utm: Universal Transverse Mercator (UTM) coordinate.
      - pygeodesy.webmercator.Wm: Web Mercator (WM) coordinate.
      - pygeodesy.datum._Registered: (INTERNAL) Base class for registered instances.
        - pygeodesy.lcc.Conic: Lambert conformal conic projection (1- or 2-SP).
        - pygeodesy.datum.Datum: Ellipsoid and transform parameters for an earth model.
        - pygeodesy.datum.Ellipsoid: Ellipsoid with major and minor radius, semi-axis, (inverse) flattening and other pre-computed, frequently used attributes.
        - pygeodesy.datum.Transform: Helmert transformation.
      - pygeodesy.bases._VectorBased: (INTERNAL) Base class for Vector3d.
        - pygeodesy.vector3d.Vector3d: Generic 3-D vector manipulation.
          - pygeodesy.ellipsoidalBase.CartesianBase: (INTERNAL) Base class for ellipsoidal Cartesian.
            - pygeodesy.ellipsoidalKarney.Cartesian: Extended to convert (geocentric) Cartesian points to Karney-based (ellipsoidal) geodetic LatLon.
            - pygeodesy.ellipsoidalNvector.Cartesian: Extended to convert (geocentric) Cartesian points to (ellipsoidal) Nvector and n-vector-based geodetic LatLon.
            - pygeodesy.ellipsoidalVincenty.Cartesian: Extended to convert (geocentric) Cartesian points to Vincenty-based (ellipsoidal) geodetic LatLon.
          - pygeodesy.nvector.Nvector: Base class for ellipsoidal and spherical Nvector.
            - pygeodesy.ellipsoidalNvector.Nvector: An n-vector is a position representation using a (unit) vector normal to the earth ellipsoid.
            - pygeodesy.sphericalNvector.Nvector: An n-vector is a position representation using a (unit) vector normal to the earth's surface.
    - pygeodesy.datum._Enum: (INTERNAL) Enum-like `dict` sub-class.
  - basestring: Type basestring cannot be instantiated; it is the base for str and unicode.
    - str: str(object='') -> string
      - pygeodesy.gars.Garef: Garef class, sub-class of `str`.
      - pygeodesy.geohash.Geohash: Geohash class, sub-class of `str`.
      - pygeodesy.wgrs.Georef: Georef class, sub-class of `str`.
  - dict: dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list.
    - pygeodesy.datum._Enum: (INTERNAL) Enum-like `dict` sub-class.
  - type: type(object) -> the object's type type(name, bases, dict) -> a new type
    - abc.ABCMeta: Metaclass for defining Abstract Base Classes (ABCs).