[ 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.
- exceptions.ValueError:
Inappropriate argument value (of correct type).
- pygeodesy.errors._ValueError:
(INTERNAL) Format a
ValueError without exception
chaining.
- pygeodesy.albers.AlbersError:
An AlbersEqualArea, AlbersEqualArea2, AlbersEqualArea4, AlbersEqualAreaCylindrical, AlbersEqualAreaNorth, AlbersEqualAreaSouth or Albers7Tuple issue.
- pygeodesy.azimuthal.AzimuthalError:
An azimuthal Equidistant, EquidistantKarney, Gnomonic, LambertEqualArea, Orthographic, Stereographic or Azimuthal7Tuple issue.
- pygeodesy.css.CSSError:
Cassini-Soldner (CSS) conversion or other Css issue.
- pygeodesy.clipy.ClipError:
Clip box or clip region issue.
- pygeodesy.errors.CrossError:
Error raised for zero or near-zero vectorial cross products,
occurring for coincident or colinear points, paths or bearings.
- pygeodesy.epsg.EPSGError:
EPSG encode, decode or other Epsg issue.
- pygeodesy.ecef.EcefError:
An ECEF or
Ecef* related issue.
- pygeodesy.elliptic.EllipticError:
Elliptic integral, function, convergence or other Elliptic issue.
- pygeodesy.gars.GARSError:
Global Area Reference System (GARS) encode, decode or other Garef
issue.
- pygeodesy.karney.GeodesicError:
Error raised for geodesicx's methods for lack of convergence
or other issues.
- pygeodesy.geohash.GeohashError:
Geohash encode, decode or other Geohash issue.
- pygeodesy.errors.IntersectionError:
Error raised for path or circle intersection issues.
- pygeodesy.lcc.LCCError:
Lambert Conformal Conic
LCC or other Lcc issue.
- pygeodesy.errors.LenError:
Error raised for mis-matching
len values.
- pygeodesy.errors.LimitError:
Error raised for lat- or longitudinal deltas exceeding the
limit in functions equirectangular and equirectangular_ and nearestOn* and
simplify* functions or methods.
- pygeodesy.ltp.LocalError:
A LocalCartesian or Ltp related
issue.
- pygeodesy.mgrs.MGRSError:
Military Grid Reference System (MGRS) parse or other Mgrs issue.
- pygeodesy.errors.NumPyError:
Error raised for
NumPy errors.
- pygeodesy.osgr.OSGRError:
Ordinance Survey Grid References (OSGR) parse or other Osgr issue.
- pygeodesy.errors.ParseError:
Error parsing degrees, radians or several other formats.
- pygeodesy.errors.PointsError:
Error for an insufficient number of points.
- pygeodesy.errors.RangeError:
Error raised for lat- or longitude values outside the
clip, clipLat,
clipLon or limit range in
function clipDegrees, clipRadians, parse3llh, parseDMS, parseDMS2 or parseRad.
- pygeodesy.errors.TRFError:
Terrestrial Reference Frame (TRF), Epoch, RefFrame
or RefFrame conversion issue.
- pygeodesy.ups.UPSError:
Universal Polar Stereographic (UPS) parse or other Ups issue.
- pygeodesy.utm.UTMError:
Universal Transverse Mercator (UTM parse or other Utm issue.
- pygeodesy.utmups.UTMUPSError:
Universal Transverse Mercator/Universal Polar Stereographic
(UTM/UPS) parse, validate or other issue.
- pygeodesy.errors.UnitError:
Default exception for units issues.
- pygeodesy.errors.VectorError:
Vector3d,
Cartesian* or
*Nvector issues.
- pygeodesy.ellipsoidalVincenty.VincentyError:
Error raised from Vincenty's
direct and
inverse methods for coincident points or lack of
convergence.
- pygeodesy.wgrs.WGRSError:
World Geographic Reference System (WGRS) encode, decode or other Georef
issue.
- pygeodesy.webmercator.WebMercatorError:
Web Mercator (WM) parser or Wm
issue.
- _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.fmath.Fsum:
Precision summation similar to standard Python function
math.fsum.
- _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.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.named._Named:
(INTERNAL) Root class for named objects.
- pygeodesy.elliptic.Elliptic:
Elliptic integrals and functions.
- pygeodesy.frechet.Frechet:
Frechet base class, requires method Frechet.distance to be overloaded.
- pygeodesy.hausdorff.Hausdorff:
Hausdorff base class, requires method Hausdorff.distance to be overloaded.
- pygeodesy.iters._BaseIter:
(INTERNAL) Iterator over items with loop-back and de-duplication.
- pygeodesy.heights._HeightBase:
(INTERNAL) Interpolator base class.
- pygeodesy.named._NamedBase:
(INTERNAL) Base class with name.
- pygeodesy.ltpTuples.Aer:
Local
Azimuth-Elevation-Range (AER) in a local
tangent plane.
- pygeodesy.css.CassiniSoldner:
Cassini-Soldner projection, a Python version of Karney's C++
class CassiniSoldner.
- pygeodesy.css.Css:
Cassini-Soldner East-/Northing location.
- pygeodesy.etm.ExactTransverseMercator:
A Python version of Karney's TransverseMercatorExact C++ class, a numerically
exact transverse mercator projection, here referred to as
TMExact.
- pygeodesy.ltp.Frustum:
A rectangular pyramid, typically representing a camera's field
of view (fov) and the intersection with (or projection to) a
local tangent plane.
- pygeodesy.geodesicx.gxarea.GeodesicAreaExact:
Area and perimeter of a geodesic polygon, an enhanced version of
Karney's Python class PolygonArea using the more accurate surface area.
- pygeodesy.latlonBase.LatLonBase:
(INTERNAL) Base class for
LatLon points on spherical
or ellipsoidal earth models.
- pygeodesy.lcc.Lcc:
Lambert conformal conic East-/Northing location.
- pygeodesy.ltp.LocalCartesian:
Conversion between geodetic
(lat, lon, height) and
local cartesian (x, y, z) coordinates with
geodetic origin (lat0, lon0, height0),
transcoded from Karney's C++ class LocalCartesian.
- pygeodesy.mgrs.Mgrs:
Military Grid Reference System (MGRS/NATO) references, with method
to convert to UTM coordinates.
- pygeodesy.ltpTuples.Ned:
Local
North-Eeast-Down (NED) location in a local
tangent plane.
- pygeodesy.osgr.Osgr:
Ordinance Survey Grid References (OSGR) coordinate.
- pygeodesy.utmupsBase.UtmUpsBase:
(INTERNAL) Base class for Utm and Ups coordinates.
- pygeodesy.vector3dBase.Vector3dBase:
(INTERNAL) Generic 3-D vector base class.
- pygeodesy.webmercator.Wm:
Web Mercator (WM) coordinate.
- pygeodesy.albers._AlbersBase:
(INTERNAL) Base class for
AlbersEqualArea...
projections.
- pygeodesy.azimuthal._AzimuthalBase:
(INTERNAL) Base class for azimuthal projections.
- pygeodesy.azimuthal.Equidistant:
Azimuthal equidistant projection for the sphere**, see Snyder, pp 195-197 and MathWorld-Wolfram.
- pygeodesy.azimuthal.Gnomonic:
Azimuthal gnomonic projection for the sphere**, see Snyder, pp 164-168 and MathWorld-Wolfram.
- pygeodesy.azimuthal.LambertEqualArea:
Lambert-equal-area projection for the sphere** (aka Lambert zenithal equal-area projection, see Snyder, pp 185-187 and MathWorld-Wolfram.
- pygeodesy.azimuthal.Orthographic:
Orthographic projection for the sphere**, see Snyder, pp 148-153 and MathWorld-Wolfram.
- pygeodesy.azimuthal.Stereographic:
Stereographic projection for the sphere**, see Snyder, pp 157-160 and MathWorld-Wolfram.
- pygeodesy.azimuthal._AzimuthalGeodesic:
(INTERNAL) Base class for azimuthal projections using Karney Geodesic or exact geodesic classes GeodesicExact and GeodesicLineExact.
- pygeodesy.ecef._EcefBase:
(INTERNAL) Base class for EcefKarney, EcefVeness and EcefYou.
- pygeodesy.ecef.EcefFarrell21:
Conversion between geodetic and geocentric, aka Earth-Centered,
Earth-Fixed (ECEF) coordinates based on Jay A. Farrell's
Table 2.1, page 29.
- pygeodesy.ecef.EcefFarrell22:
Conversion between geodetic and geocentric, aka Earth-Centered,
Earth-Fixed (ECEF) coordinates based on Jay A. Farrell's
Table 2.2, page 30.
- pygeodesy.ecef.EcefKarney:
Conversion between geodetic and geocentric, aka Earth-Centered,
Earth-Fixed (ECEF) coordinates transcoded from Karney's
C++ Geocentric methods.
- pygeodesy.ecef.EcefSudano:
Conversion between geodetic and geocentric, aka Earth-Centered,
Earth-Fixed (ECEF) coordinates based on John J. Sudano's
paper.
- pygeodesy.ecef.EcefVeness:
Conversion between geodetic and geocentric, aka Earth-Centered,
Earth-Fixed (ECEF) coordinates transcoded from Chris
Veness' JavaScript classes LatLonEllipsoidal, Cartesian.
- pygeodesy.ecef.EcefYou:
Conversion between geodetic and geocentric, aka Earth-Centered,
Earth-Fixed (ECEF) coordinates using Rey-Jer You's transformation.
- pygeodesy.geodesicx.gxbases._GeodesicBase:
(INTERNAL) Base class for
[_]Geodesic*Exact.
- pygeodesy.named._NamedEnumItem:
(INTERNAL) Base class for items in a
_NamedEnum
registery.
- pygeodesy.named._NamedDict:
(INTERNAL) Named
dict with key and attribute
access to the items.
- pygeodesy.named._NamedTuple:
(INTERNAL) Base for named
tuples with both index
and attribute name access to the items.
- pygeodesy.ltpTuples.Aer4Tuple:
4-Tuple
(azimuth, elevation, slantrange, ltp), all in
meter except ltp.
- pygeodesy.albers.Albers7Tuple:
7-Tuple
(x, y, lat, lon, gamma, scale, datum), in
meter, meter, degrees90,
degrees180, degrees360,
scalar and Datum where (x,
y) is the projected, (lat, lon) the geodetic
location, gamma the meridian convergence at point, the
bearing of the y-axis measured clockwise from true North and
scale is the azimuthal scale of the projection at
point.
- pygeodesy.azimuthal.Azimuthal7Tuple:
7-Tuple
(x, y, lat, lon, azimuth, scale, datum), in
meter, meter, degrees90,
degrees180, compass degrees,
scalar and Datum where (x,
y) is the easting and northing of a projected point,
(lat, lon) the geodetic location, azimuth
the azimuth, clockwise from true North and scale is
the projection scale, either 1 / reciprocal or
1 or -1 in the Equidistant case.
- pygeodesy.namedTuples.Bearing2Tuple:
2-Tuple
(initial, final) bearings, both in compass
degrees360.
- pygeodesy.namedTuples.Bounds2Tuple:
2-Tuple
(latlonSW, latlonNE) with the bounds'
lower-left and upper-right corner as LatLon instance.
- pygeodesy.namedTuples.Bounds4Tuple:
4-Tuple
(latS, lonW, latN, lonE) with the bounds'
lower-left (LatS, LowW) and upper-right (latN,
lonE) corner lat- and longitudes.
- pygeodesy.ellipsoids.Circle4Tuple:
4-Tuple
(radius, height, lat, beta) of the
radius and height, both conventionally in
meter of a parallel circle of latitude at
(geodetic) latitude lat and the parametric (or
reduced) auxiliary latitude beta, both in
degrees90.
- pygeodesy.vector3d.Circum3Tuple:
3-Tuple
(radius, center, deltas) with the
circumradius and trilaterated
circumcenter of the circumcircle through
3 points (aka {Meeus}' Type II circle) or the radius
and center of the smallest Meeus' Type I
circle.
- pygeodesy.deprecated.ClipCS3Tuple:
3-Tuple
(start, end, index).
- pygeodesy.clipy.ClipCS4Tuple:
4-Tuple
(start, end, i, j) for each edge of a
clipped path with the start and
end points (LatLon) of the portion of the
edge inside or on the clip box and the indices i and
j (int) of the edge start and end points
in the original path.
- pygeodesy.clipy.ClipLB6Tuple:
6-Tuple
(start, end, i, fi, fj, j) for each edge of
the clipped path with the start and
end points (LatLon) of the portion of the
edge inside or on the clip box, indices i and
j (int) of the original path edge start
and end points and fractional indices fi and
fj (FIx) of the start and
end points along the edge of the original path.
- pygeodesy.clipy.ClipSH3Tuple:
3-Tuple
(start, end, original) for each edge of a
clipped polygon, the start and end
points (LatLon) of the portion of the edge inside or
on the clip region and original indicates whether the
edge is part of the original polygon or part of the clip region
(bool).
- pygeodesy.ellipsoids.Curvature2Tuple:
2-Tuple
(meridional, prime_vertical) of radii of
curvature, both in meter, conventionally.
- pygeodesy.namedTuples.Destination2Tuple:
2-Tuple
(destination, final), destination
in LatLon and final bearing in compass
degrees360.
- pygeodesy.namedTuples.Destination3Tuple:
3-Tuple
(lat, lon, final), destination
lat, lon in degrees90
respectively degrees180 and final bearing
in compass degrees360.
- pygeodesy.namedTuples.Distance2Tuple:
2-Tuple
(distance, initial), distance in
meter and initial bearing in compass
degrees360.
- pygeodesy.namedTuples.Distance3Tuple:
3-Tuple
(distance, initial, final),
distance in meter and
initial and final bearing, both in
compass degrees360.
- pygeodesy.namedTuples.Distance4Tuple:
4-Tuple
(distance2, delta_lat, delta_lon, unroll_lon2)
with the distance in degrees squared, the latitudinal
delta_lat = lat2 - lat1, the wrapped,
unrolled and adjusted longitudinal delta_lon = lon2 -
lon1 and unroll_lon2, the unrolled or
original lon2.
- pygeodesy.namedTuples.EasNor2Tuple:
2-Tuple
(easting, northing), both in
meter, conventionally.
- pygeodesy.namedTuples.EasNor3Tuple:
3-Tuple
(easting, northing, height), all in
meter, conventionally.
- pygeodesy.css.EasNorAziRk4Tuple:
4-Tuple
(easting, northing, azimuth, reciprocal) for
the Cassini-Soldner location with easting and
northing in meters and the
azimuth of easting direction and
reciprocal of azimuthal northing scale, both in
degrees.
- pygeodesy.etm.EasNorExact4Tuple:
4-Tuple
(easting, northing, convergence, scale) in
meter, meter, degrees and
scalar.
- pygeodesy.webmercator.EasNorRadius3Tuple:
3-Tuple
(easting, northing, radius), all in
meter.
- pygeodesy.ecef.Ecef9Tuple:
9-Tuple
(x, y, z, lat, lon, height, C, M, datum) with
geocentric x, y and z
plus geodetic lat, lon and
height, case C (see the
Ecef*.reverse methods) and optionally, the rotation
matrix M (EcefMatrix) and datum, with
lat and lon in degrees and
x, y, z and
height in meter, conventionally.
- pygeodesy.ecef.EcefMatrix:
A rotation matrix.
- pygeodesy.elevations.Elevation2Tuple:
2-Tuple
(elevation, data_source) in meter
and str.
- pygeodesy.elliptic.Elliptic3Tuple:
3-Tuple
(sn, cn, dn) all scalar.
- pygeodesy.ltpTuples.Enu4Tuple:
4-Tuple
(east, north, up, ltp), in meter
except ltp.
- pygeodesy.ltpTuples.Footprint5Tuple:
5-Tuple
(center, upperleft, upperight, loweright,
lowerleft) with the center and 4 corners of a
local projection of a Frustum, each an Xyz4Tuple.
- pygeodesy.frechet.Frechet6Tuple:
6-Tuple
(fd, fi1, fi2, r, n, units) with the
discrete Fréchet distance fd,
fractional indices fi1 and fi2 as
FIx, the recursion depth r, the number of
distances computed n and the units class or class or name of the distance
units.
- pygeodesy.elevations.GeoidHeight2Tuple:
2-Tuple
(height, model_name), geoid
height in meter and
model_name as str.
- pygeodesy.geoids.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).
- pygeodesy.hausdorff.Hausdorff6Tuple:
6-Tuple
(hd, i, j, mn, md, units) with the Hausdorff distance hd, indices
i and j, the total count mn,
the mean Hausdorff distance md and
the class or name of both distance units.
- pygeodesy.namedTuples.Intersection3Tuple:
3-Tuple
(point, outside1, outside2) of an intersection
point and outside1, the position of the
point, -1 if before the start,
+1 if after the end and 0 if on or
between the stat and end point of the first line.
- pygeodesy.namedTuples.LatLon2Tuple:
2-Tuple
(lat, lon) in degrees90 and
degrees180.
- pygeodesy.namedTuples.LatLon3Tuple:
3-Tuple
(lat, lon, height) in degrees90,
degrees180 and meter, conventionally.
- pygeodesy.namedTuples.LatLon4Tuple:
4-Tuple
(lat, lon, height, datum) in
degrees90, degrees180, meter
and Datum.
- pygeodesy.css.LatLonAziRk4Tuple:
4-Tuple
(lat, lon, azimuth, reciprocal), all in
degrees where azimuth is the azimuth of
easting direction and reciprocal the reciprocal of
azimuthal northing scale.
- pygeodesy.namedTuples.LatLonDatum3Tuple:
3-Tuple
(lat, lon, datum) in degrees90,
degrees180 and Datum.
- pygeodesy.namedTuples.LatLonDatum5Tuple:
5-Tuple
(lat, lon, datum, convergence, scale) in
degrees90, degrees180, Datum,
degrees and float.
- pygeodesy.etm.LatLonExact4Tuple:
4-Tuple
(lat, lon, convergence, scale) in
degrees180, degrees180,
degrees and scalar.
- pygeodesy.namedTuples.LatLonPrec3Tuple:
3-Tuple
(lat, lon, precision) in degrees,
degrees and int.
- pygeodesy.namedTuples.LatLonPrec5Tuple:
5-Tuple
(lat, lon, precision, height, radius) in
degrees, degrees, int and
height or radius in meter
(or None if missing).
- pygeodesy.ltpTuples.Local9Tuple:
9-Tuple
(x, y, z, lat, lon, height, ltp, ecef, M) with
local x, y, z all in
meter, geodetic lat,
lon, height, local tangent plane
ltp (Ltp), ecef (Ecef9Tuple) with geocentric x,
y, z, geodetic lat,
lon, height and concatenated
rotation matrix M (EcefMatrix) or None.
- pygeodesy.vector3d.Meeus2Tuple:
2-Tuple
(radius, Type) with radius and
Meeus' {Type} of the smallest circle containing 3
points.
- pygeodesy.mgrs.Mgrs4Tuple:
4-Tuple
(zone, digraph, easting, northing),
zone and digraph as str,
easting and northing in
meter.
- pygeodesy.mgrs.Mgrs6Tuple:
6-Tuple
(zone, digraph, easting, northing, band,
datum), zone, digraph and
band as str, easting and
northing in meter and datum
a Datum.
- pygeodesy.namedTuples.NearestOn3Tuple:
3-Tuple
(closest, distance, angle) of the
closest point on the polygon, either a
LatLon instance or a LatLon3Tuple(lat, lon, height) and
the distance and angle to the
closest point are in meter respectively
compass degrees360.
- pygeodesy.points.NearestOn5Tuple:
5-Tuple
(lat, lon, distance, angle, height) all in
degrees, except height.
- pygeodesy.ellipsoidalNvector.Ned3Tuple:
3-Tuple
(north, east, down).
- pygeodesy.ltpTuples.Ned4Tuple:
4-Tuple
(north, east, down, ltp), all in
meter except ltp.
- pygeodesy.namedTuples.PhiLam2Tuple:
2-Tuple
(phi, lam) with latitude phi in
radians[PI_2] and longitude lam in
radians[PI].
- pygeodesy.namedTuples.PhiLam3Tuple:
3-Tuple
(phi, lam, height) with latitude
phi in radians[PI_2], longitude
lam in radians[PI] and
height in meter.
- pygeodesy.namedTuples.PhiLam4Tuple:
4-Tuple
(phi, lam, height, datum) with latitude
phi in radians[PI_2], longitude
lam in radians[PI], height
in meter and Datum.
- pygeodesy.namedTuples.Point3Tuple:
3-Tuple
(x, y, ll) in meter,
meter and LatLon.
- pygeodesy.namedTuples.Points2Tuple:
2-Tuple
(number, points) with the number
of points and -possible reduced- list or
tuple of points.
- pygeodesy.formy.Radical2Tuple:
2-Tuple
(ratio, xline) of the radical
ratio and radical xline, both
scalar and 0.0 <= ratio <= 1.0
- pygeodesy.geohash.Resolutions2Tuple:
2-Tuple
(res1, res2) with the primary
(longitudinal) and secondary (latitudinal)
resolution, both in degrees.
- pygeodesy.points.Shape2Tuple:
2-Tuple
(nrows, ncols), the number of rows and
columns, both int.
- pygeodesy.trf.Transform7Tuple:
7-Tuple
(tx, ty, tz, s, sx, sy, sz) Helmert
transformation with translations tx, ty
and tz in millimeter, scale
s in ppb and rotations sx,
sy and sz in
milliarcseconds.
- pygeodesy.namedTuples.Triangle7Tuple:
7-Tuple
(A, a, B, b, C, c, area) with interior angles
A, B and C in
degrees, spherical sides a,
b and c in meter and the
area of a spherical triangle in square
meter.
- pygeodesy.namedTuples.Triangle8Tuple:
8-Tuple
(A, a, B, b, C, c, D, E) with interior angles
A, B and C, spherical sides
a, b and c, spherical
deficit D and spherical excess
E of a spherical triangle, all in
radians.
- pygeodesy.namedTuples.Trilaterate5Tuple:
5-Tuple
(min, minPoint, max, maxPoint, n) with
min and max in meter, the
corresponding trilaterated minPoint and
maxPoint as LatLon and the number
n.
- pygeodesy.namedTuples.UtmUps2Tuple:
2-Tuple
(zone, hemipole) as int and
str, where zone is 1..60 for
UTM or 0 for UPS and hemipole
'N'|'S' is the UTM hemisphere or the UPS pole.
- pygeodesy.deprecated.UtmUps4Tuple:
OBSOLETE, expect a UtmUps5Tuple from method
Mgrs.toUtm(utm=None).
- pygeodesy.namedTuples.UtmUps5Tuple:
5-Tuple
(zone, hemipole, easting, northing, band) as
int, str, meter,
meter and band letter, where
zone is 1..60 for UTM or 0
for UPS, hemipole 'N'|'S' is the UTM
hemisphere or the UPS pole and band is
"" or the (longitudinal) UTM band
'C'|'D'..'W'|'X' or the (polar) UPS band
'A'|'B'|'Y'|'Z'.
- pygeodesy.namedTuples.UtmUps8Tuple:
8-Tuple
(zone, hemipole, easting, northing, band, datum,
convergence, scale) as int, str,
meter, meter, band letter,
Datum, degrees and scalar,
where zone is 1..60 for UTM or
0 for UPS, hemipole 'N'|'S'
is the UTM hemisphere or the UPS pole and band is
"" or the (longitudinal) UTM band
'C'|'D'..'W'|'X' or the (polar) UPS band
'A'|'B'|'Y'|'Z'.
- pygeodesy.namedTuples.UtmUpsLatLon5Tuple:
5-Tuple
(zone, band, hemipole, lat, lon) as
int, str, str,
degrees90 and degrees180, where
zone is 1..60 for UTM or 0
for UPS, band is "" or the
(longitudinal) UTM band 'C'|'D'..'W'|'X' or (polar)
UPS band 'A'|'B'|'Y'|'Z' and hemipole
'N'|'S' is the UTM hemisphere or the UPS pole.
- pygeodesy.namedTuples.Vector2Tuple:
2-Tuple
(x, y) of (geocentric) components, both in
meter or units.
- pygeodesy.namedTuples.Vector3Tuple:
3-Tuple
(x, y, z) of (geocentric) components, all in
meter or units.
- pygeodesy.namedTuples.Vector4Tuple:
4-Tuple
(x, y, z, h) of (geocentric) components, all
in meter or units.
- pygeodesy.ltpTuples.Xyz4Tuple:
4-Tuple
(x, y, z, ltp), all in meter
except ltp.
- pygeodesy.karney._GTuple:
(INTERNAL) Helper.
- pygeodesy.karney.Direct9Tuple:
9-Tuple
(a12, lat2, lon2, azi2, s12, m12, M12, M21,
S12) with arc length a12, angles
lat2, lon2 and azimuth azi2
in degrees, distance s12 and reduced
length m12 in meter and area
S12 in meter squared.
- pygeodesy.karney.GeodSolve12Tuple:
12-Tuple
(lat1, lon1, azi1, lat2, lon2, azi2, s12, a12, m12,
M12, M21, S12) with angles lat1,
lon1, azi1, lat2,
lon2 and azi2 and arc a12
all in degrees, distance s12 and reduced
length m12 in meter, area
S12 in meter squared and geodesic
scales M12 and M21 scalar,
see GeodSolve.
- pygeodesy.karney.Inverse10Tuple:
10-Tuple
(a12, s12, salp1, calp1, salp2, calp2, m12, M12,
M21, S12) with arc length a12 in
degrees, distance s12 and reduced length
m12 in meter, area S12 in
meter squared and sines and cosines of initial
and final (forward) azimuths.
- pygeodesy.ellipsoids.a_f2Tuple:
2-Tuple
(a, f) specifying an ellipsoid by
equatorial radius a in meter and
scalar flattening f.
- pygeodesy.units._NamedUnit:
(INTERNAL) Base class for
units.
- pygeodesy.units.Bool:
Named
bool, a sub-class of int like
Python's bool.
- pygeodesy.units.Float:
Named
float.
- pygeodesy.units.Degrees:
Named
float representing a coordinate in
degrees, optionally clipped.
- pygeodesy.units.Degrees2:
Named
float representing a distance in degrees
squared.
- pygeodesy.units.Distance:
Named
float representing a distance, conventionally in
meter.
- pygeodesy.units.Easting:
Named
float representing an easting, conventionally in
meter.
- pygeodesy.units.Feet:
Named
float representing a distance or length in
feet.
- pygeodesy.units.Float_:
Named
float with optional low and
high limit.
- pygeodesy.units.Height:
Named
float representing a height, conventionally in
meter.
- pygeodesy.units.Meter:
Named
float representing a distance or length in
meter.
- pygeodesy.units.Northing:
Named
float representing a northing, conventionally in
meter.
- pygeodesy.units.Radians:
Named
float representing a coordinate in
radians, optionally clipped.
- pygeodesy.units.Radius:
Named
float representing a radius, conventionally in
meter.
- pygeodesy.units.Scalar:
Named
float representing a factor, fraction, scale,
etc.
- pygeodesy.units.Int:
Named
int.
- pygeodesy.units.Str:
Named
str.
- basestring:
Type basestring cannot be instantiated; it is the base for str and
unicode.
- str:
str(object='') -> string
- 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.named._Dict:
(INTERNAL) An
dict with both key and attribute
access to the dict items.
- pygeodesy.karney.GDict:
Basic
dict with both key and attribute access
to the dict items.
- pygeodesy.named._NamedDict:
(INTERNAL) Named
dict with key and attribute
access to the items.
- float:
float(x) -> floating point number
- pygeodesy.units.Float:
Named
float.
- pygeodesy.units.Degrees:
Named
float representing a coordinate in
degrees, optionally clipped.
- pygeodesy.units.Degrees2:
Named
float representing a distance in degrees
squared.
- pygeodesy.units.Distance:
Named
float representing a distance, conventionally in
meter.
- pygeodesy.units.Easting:
Named
float representing an easting, conventionally in
meter.
- pygeodesy.units.Feet:
Named
float representing a distance or length in
feet.
- pygeodesy.units.Float_:
Named
float with optional low and
high limit.
- pygeodesy.units.Height:
Named
float representing a height, conventionally in
meter.
- pygeodesy.units.Meter:
Named
float representing a distance or length in
meter.
- pygeodesy.units.Northing:
Named
float representing a northing, conventionally in
meter.
- pygeodesy.units.Radians:
Named
float representing a coordinate in
radians, optionally clipped.
- pygeodesy.units.Radius:
Named
float representing a radius, conventionally in
meter.
- pygeodesy.units.Scalar:
Named
float representing a factor, fraction, scale,
etc.
- int:
int(x=0) -> int or long int(x, base=10) -> int or long
- property:
property(fget=None, fset=None, fdel=None, doc=None) -> property attribute
- pygeodesy.props._PropertyBase:
(INTERNAL) Base class for
P/property/_RO.
- tuple:
tuple() -> empty tuple tuple(iterable) -> tuple initialized
from iterable's items
- pygeodesy.named._NamedTuple:
(INTERNAL) Base for named
tuples with both index
and attribute name access to the items.
- pygeodesy.ltpTuples.Aer4Tuple:
4-Tuple
(azimuth, elevation, slantrange, ltp), all in
meter except ltp.
- pygeodesy.albers.Albers7Tuple:
7-Tuple
(x, y, lat, lon, gamma, scale, datum), in
meter, meter, degrees90,
degrees180, degrees360,
scalar and Datum where (x,
y) is the projected, (lat, lon) the geodetic
location, gamma the meridian convergence at point, the
bearing of the y-axis measured clockwise from true North and
scale is the azimuthal scale of the projection at
point.
- pygeodesy.azimuthal.Azimuthal7Tuple:
7-Tuple
(x, y, lat, lon, azimuth, scale, datum), in
meter, meter, degrees90,
degrees180, compass degrees,
scalar and Datum where (x,
y) is the easting and northing of a projected point,
(lat, lon) the geodetic location, azimuth
the azimuth, clockwise from true North and scale is
the projection scale, either 1 / reciprocal or
1 or -1 in the Equidistant case.
- pygeodesy.namedTuples.Bearing2Tuple:
2-Tuple
(initial, final) bearings, both in compass
degrees360.
- pygeodesy.namedTuples.Bounds2Tuple:
2-Tuple
(latlonSW, latlonNE) with the bounds'
lower-left and upper-right corner as LatLon instance.
- pygeodesy.namedTuples.Bounds4Tuple:
4-Tuple
(latS, lonW, latN, lonE) with the bounds'
lower-left (LatS, LowW) and upper-right (latN,
lonE) corner lat- and longitudes.
- pygeodesy.ellipsoids.Circle4Tuple:
4-Tuple
(radius, height, lat, beta) of the
radius and height, both conventionally in
meter of a parallel circle of latitude at
(geodetic) latitude lat and the parametric (or
reduced) auxiliary latitude beta, both in
degrees90.
- pygeodesy.vector3d.Circum3Tuple:
3-Tuple
(radius, center, deltas) with the
circumradius and trilaterated
circumcenter of the circumcircle through
3 points (aka {Meeus}' Type II circle) or the radius
and center of the smallest Meeus' Type I
circle.
- pygeodesy.deprecated.ClipCS3Tuple:
3-Tuple
(start, end, index).
- pygeodesy.clipy.ClipCS4Tuple:
4-Tuple
(start, end, i, j) for each edge of a
clipped path with the start and
end points (LatLon) of the portion of the
edge inside or on the clip box and the indices i and
j (int) of the edge start and end points
in the original path.
- pygeodesy.clipy.ClipLB6Tuple:
6-Tuple
(start, end, i, fi, fj, j) for each edge of
the clipped path with the start and
end points (LatLon) of the portion of the
edge inside or on the clip box, indices i and
j (int) of the original path edge start
and end points and fractional indices fi and
fj (FIx) of the start and
end points along the edge of the original path.
- pygeodesy.clipy.ClipSH3Tuple:
3-Tuple
(start, end, original) for each edge of a
clipped polygon, the start and end
points (LatLon) of the portion of the edge inside or
on the clip region and original indicates whether the
edge is part of the original polygon or part of the clip region
(bool).
- pygeodesy.ellipsoids.Curvature2Tuple:
2-Tuple
(meridional, prime_vertical) of radii of
curvature, both in meter, conventionally.
- pygeodesy.namedTuples.Destination2Tuple:
2-Tuple
(destination, final), destination
in LatLon and final bearing in compass
degrees360.
- pygeodesy.namedTuples.Destination3Tuple:
3-Tuple
(lat, lon, final), destination
lat, lon in degrees90
respectively degrees180 and final bearing
in compass degrees360.
- pygeodesy.namedTuples.Distance2Tuple:
2-Tuple
(distance, initial), distance in
meter and initial bearing in compass
degrees360.
- pygeodesy.namedTuples.Distance3Tuple:
3-Tuple
(distance, initial, final),
distance in meter and
initial and final bearing, both in
compass degrees360.
- pygeodesy.namedTuples.Distance4Tuple:
4-Tuple
(distance2, delta_lat, delta_lon, unroll_lon2)
with the distance in degrees squared, the latitudinal
delta_lat = lat2 - lat1, the wrapped,
unrolled and adjusted longitudinal delta_lon = lon2 -
lon1 and unroll_lon2, the unrolled or
original lon2.
- pygeodesy.namedTuples.EasNor2Tuple:
2-Tuple
(easting, northing), both in
meter, conventionally.
- pygeodesy.namedTuples.EasNor3Tuple:
3-Tuple
(easting, northing, height), all in
meter, conventionally.
- pygeodesy.css.EasNorAziRk4Tuple:
4-Tuple
(easting, northing, azimuth, reciprocal) for
the Cassini-Soldner location with easting and
northing in meters and the
azimuth of easting direction and
reciprocal of azimuthal northing scale, both in
degrees.
- pygeodesy.etm.EasNorExact4Tuple:
4-Tuple
(easting, northing, convergence, scale) in
meter, meter, degrees and
scalar.
- pygeodesy.webmercator.EasNorRadius3Tuple:
3-Tuple
(easting, northing, radius), all in
meter.
- pygeodesy.ecef.Ecef9Tuple:
9-Tuple
(x, y, z, lat, lon, height, C, M, datum) with
geocentric x, y and z
plus geodetic lat, lon and
height, case C (see the
Ecef*.reverse methods) and optionally, the rotation
matrix M (EcefMatrix) and datum, with
lat and lon in degrees and
x, y, z and
height in meter, conventionally.
- pygeodesy.ecef.EcefMatrix:
A rotation matrix.
- pygeodesy.elevations.Elevation2Tuple:
2-Tuple
(elevation, data_source) in meter
and str.
- pygeodesy.elliptic.Elliptic3Tuple:
3-Tuple
(sn, cn, dn) all scalar.
- pygeodesy.ltpTuples.Enu4Tuple:
4-Tuple
(east, north, up, ltp), in meter
except ltp.
- pygeodesy.ltpTuples.Footprint5Tuple:
5-Tuple
(center, upperleft, upperight, loweright,
lowerleft) with the center and 4 corners of a
local projection of a Frustum, each an Xyz4Tuple.
- pygeodesy.frechet.Frechet6Tuple:
6-Tuple
(fd, fi1, fi2, r, n, units) with the
discrete Fréchet distance fd,
fractional indices fi1 and fi2 as
FIx, the recursion depth r, the number of
distances computed n and the units class or class or name of the distance
units.
- pygeodesy.elevations.GeoidHeight2Tuple:
2-Tuple
(height, model_name), geoid
height in meter and
model_name as str.
- pygeodesy.geoids.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).
- pygeodesy.hausdorff.Hausdorff6Tuple:
6-Tuple
(hd, i, j, mn, md, units) with the Hausdorff distance hd, indices
i and j, the total count mn,
the mean Hausdorff distance md and
the class or name of both distance units.
- pygeodesy.namedTuples.Intersection3Tuple:
3-Tuple
(point, outside1, outside2) of an intersection
point and outside1, the position of the
point, -1 if before the start,
+1 if after the end and 0 if on or
between the stat and end point of the first line.
- pygeodesy.namedTuples.LatLon2Tuple:
2-Tuple
(lat, lon) in degrees90 and
degrees180.
- pygeodesy.namedTuples.LatLon3Tuple:
3-Tuple
(lat, lon, height) in degrees90,
degrees180 and meter, conventionally.
- pygeodesy.namedTuples.LatLon4Tuple:
4-Tuple
(lat, lon, height, datum) in
degrees90, degrees180, meter
and Datum.
- pygeodesy.css.LatLonAziRk4Tuple:
4-Tuple
(lat, lon, azimuth, reciprocal), all in
degrees where azimuth is the azimuth of
easting direction and reciprocal the reciprocal of
azimuthal northing scale.
- pygeodesy.namedTuples.LatLonDatum3Tuple:
3-Tuple
(lat, lon, datum) in degrees90,
degrees180 and Datum.
- pygeodesy.namedTuples.LatLonDatum5Tuple:
5-Tuple
(lat, lon, datum, convergence, scale) in
degrees90, degrees180, Datum,
degrees and float.
- pygeodesy.etm.LatLonExact4Tuple:
4-Tuple
(lat, lon, convergence, scale) in
degrees180, degrees180,
degrees and scalar.
- pygeodesy.namedTuples.LatLonPrec3Tuple:
3-Tuple
(lat, lon, precision) in degrees,
degrees and int.
- pygeodesy.namedTuples.LatLonPrec5Tuple:
5-Tuple
(lat, lon, precision, height, radius) in
degrees, degrees, int and
height or radius in meter
(or None if missing).
- pygeodesy.ltpTuples.Local9Tuple:
9-Tuple
(x, y, z, lat, lon, height, ltp, ecef, M) with
local x, y, z all in
meter, geodetic lat,
lon, height, local tangent plane
ltp (Ltp), ecef (Ecef9Tuple) with geocentric x,
y, z, geodetic lat,
lon, height and concatenated
rotation matrix M (EcefMatrix) or None.
- pygeodesy.vector3d.Meeus2Tuple:
2-Tuple
(radius, Type) with radius and
Meeus' {Type} of the smallest circle containing 3
points.
- pygeodesy.mgrs.Mgrs4Tuple:
4-Tuple
(zone, digraph, easting, northing),
zone and digraph as str,
easting and northing in
meter.
- pygeodesy.mgrs.Mgrs6Tuple:
6-Tuple
(zone, digraph, easting, northing, band,
datum), zone, digraph and
band as str, easting and
northing in meter and datum
a Datum.
- pygeodesy.namedTuples.NearestOn3Tuple:
3-Tuple
(closest, distance, angle) of the
closest point on the polygon, either a
LatLon instance or a LatLon3Tuple(lat, lon, height) and
the distance and angle to the
closest point are in meter respectively
compass degrees360.
- pygeodesy.points.NearestOn5Tuple:
5-Tuple
(lat, lon, distance, angle, height) all in
degrees, except height.
- pygeodesy.ellipsoidalNvector.Ned3Tuple:
3-Tuple
(north, east, down).
- pygeodesy.ltpTuples.Ned4Tuple:
4-Tuple
(north, east, down, ltp), all in
meter except ltp.
- pygeodesy.namedTuples.PhiLam2Tuple:
2-Tuple
(phi, lam) with latitude phi in
radians[PI_2] and longitude lam in
radians[PI].
- pygeodesy.namedTuples.PhiLam3Tuple:
3-Tuple
(phi, lam, height) with latitude
phi in radians[PI_2], longitude
lam in radians[PI] and
height in meter.
- pygeodesy.namedTuples.PhiLam4Tuple:
4-Tuple
(phi, lam, height, datum) with latitude
phi in radians[PI_2], longitude
lam in radians[PI], height
in meter and Datum.
- pygeodesy.namedTuples.Point3Tuple:
3-Tuple
(x, y, ll) in meter,
meter and LatLon.
- pygeodesy.namedTuples.Points2Tuple:
2-Tuple
(number, points) with the number
of points and -possible reduced- list or
tuple of points.
- pygeodesy.formy.Radical2Tuple:
2-Tuple
(ratio, xline) of the radical
ratio and radical xline, both
scalar and 0.0 <= ratio <= 1.0
- pygeodesy.geohash.Resolutions2Tuple:
2-Tuple
(res1, res2) with the primary
(longitudinal) and secondary (latitudinal)
resolution, both in degrees.
- pygeodesy.points.Shape2Tuple:
2-Tuple
(nrows, ncols), the number of rows and
columns, both int.
- pygeodesy.trf.Transform7Tuple:
7-Tuple
(tx, ty, tz, s, sx, sy, sz) Helmert
transformation with translations tx, ty
and tz in millimeter, scale
s in ppb and rotations sx,
sy and sz in
milliarcseconds.
- pygeodesy.namedTuples.Triangle7Tuple:
7-Tuple
(A, a, B, b, C, c, area) with interior angles
A, B and C in
degrees, spherical sides a,
b and c in meter and the
area of a spherical triangle in square
meter.
- pygeodesy.namedTuples.Triangle8Tuple:
8-Tuple
(A, a, B, b, C, c, D, E) with interior angles
A, B and C, spherical sides
a, b and c, spherical
deficit D and spherical excess
E of a spherical triangle, all in
radians.
- pygeodesy.namedTuples.Trilaterate5Tuple:
5-Tuple
(min, minPoint, max, maxPoint, n) with
min and max in meter, the
corresponding trilaterated minPoint and
maxPoint as LatLon and the number
n.
- pygeodesy.namedTuples.UtmUps2Tuple:
2-Tuple
(zone, hemipole) as int and
str, where zone is 1..60 for
UTM or 0 for UPS and hemipole
'N'|'S' is the UTM hemisphere or the UPS pole.
- pygeodesy.deprecated.UtmUps4Tuple:
OBSOLETE, expect a UtmUps5Tuple from method
Mgrs.toUtm(utm=None).
- pygeodesy.namedTuples.UtmUps5Tuple:
5-Tuple
(zone, hemipole, easting, northing, band) as
int, str, meter,
meter and band letter, where
zone is 1..60 for UTM or 0
for UPS, hemipole 'N'|'S' is the UTM
hemisphere or the UPS pole and band is
"" or the (longitudinal) UTM band
'C'|'D'..'W'|'X' or the (polar) UPS band
'A'|'B'|'Y'|'Z'.
- pygeodesy.namedTuples.UtmUps8Tuple:
8-Tuple
(zone, hemipole, easting, northing, band, datum,
convergence, scale) as int, str,
meter, meter, band letter,
Datum, degrees and scalar,
where zone is 1..60 for UTM or
0 for UPS, hemipole 'N'|'S'
is the UTM hemisphere or the UPS pole and band is
"" or the (longitudinal) UTM band
'C'|'D'..'W'|'X' or the (polar) UPS band
'A'|'B'|'Y'|'Z'.
- pygeodesy.namedTuples.UtmUpsLatLon5Tuple:
5-Tuple
(zone, band, hemipole, lat, lon) as
int, str, str,
degrees90 and degrees180, where
zone is 1..60 for UTM or 0
for UPS, band is "" or the
(longitudinal) UTM band 'C'|'D'..'W'|'X' or (polar)
UPS band 'A'|'B'|'Y'|'Z' and hemipole
'N'|'S' is the UTM hemisphere or the UPS pole.
- pygeodesy.namedTuples.Vector2Tuple:
2-Tuple
(x, y) of (geocentric) components, both in
meter or units.
- pygeodesy.namedTuples.Vector3Tuple:
3-Tuple
(x, y, z) of (geocentric) components, all in
meter or units.
- pygeodesy.namedTuples.Vector4Tuple:
4-Tuple
(x, y, z, h) of (geocentric) components, all
in meter or units.
- pygeodesy.ltpTuples.Xyz4Tuple:
4-Tuple
(x, y, z, ltp), all in meter
except ltp.
- pygeodesy.karney._GTuple:
(INTERNAL) Helper.
- pygeodesy.karney.Direct9Tuple:
9-Tuple
(a12, lat2, lon2, azi2, s12, m12, M12, M21,
S12) with arc length a12, angles
lat2, lon2 and azimuth azi2
in degrees, distance s12 and reduced
length m12 in meter and area
S12 in meter squared.
- pygeodesy.karney.GeodSolve12Tuple:
12-Tuple
(lat1, lon1, azi1, lat2, lon2, azi2, s12, a12, m12,
M12, M21, S12) with angles lat1,
lon1, azi1, lat2,
lon2 and azi2 and arc a12
all in degrees, distance s12 and reduced
length m12 in meter, area
S12 in meter squared and geodesic
scales M12 and M21 scalar,
see GeodSolve.
- pygeodesy.karney.Inverse10Tuple:
10-Tuple
(a12, s12, salp1, calp1, salp2, calp2, m12, M12,
M21, S12) with arc length a12 in
degrees, distance s12 and reduced length
m12 in meter, area S12 in
meter squared and sines and cosines of initial
and final (forward) azimuths.
- pygeodesy.ellipsoids.a_f2Tuple:
2-Tuple
(a, f) specifying an ellipsoid by
equatorial radius a in meter and
scalar flattening f.
- type:
type(object) -> the object's type type(name, bases, dict) ->
a new type
- abc.ABCMeta:
Metaclass for defining Abstract Base Classes (ABCs).