Package pygeodesy :: Package deprecated

Package deprecated

DEPRECATED classes, constants, functions, interns, methods, etc. and all lazily imported.

Kept for backward compatibility, including DEPRECATED modules pygeodesy.bases, pygeodesy.datum and pygeodesy.nvector. Use either from pygeodesy import bases or from pygeodesy.deprecated import bases. Likewise for datum and nvector.

Version: 24.04.17

Submodules

pygeodesy.deprecated.bases: DEPRECATED on 2021.02.10, use (INTERNAL) module pygeodesy.latlonBase instead.
pygeodesy.deprecated.classes: DEPRECATED classes kept for backward compatibility.
pygeodesy.deprecated.consterns: DEPRECATED constants and interns kept for backward compatibility.
pygeodesy.deprecated.datum: DEPRECATED on 2022.09.12, use module pygeodesy.datums or pygeodesy.ellipsoids instead.
pygeodesy.deprecated.functions: DEPRECATED functions kept for backward compatibility.
pygeodesy.deprecated.nvector: DEPRECATED on 2021.05.20, use (INTERNAL) module pygeodesy.nvectorBase instead.
pygeodesy.deprecated.rhumbBase: DEPRECATED on 2023.11.26, use module pygeodesy.rhumb.bases instead.
pygeodesy.deprecated.rhumbaux: DEPRECATED on 2023.11.26, use module pygeodesy.rhumb.aux_ instead.
pygeodesy.deprecated.rhumbsolve: DEPRECATED on 2023.11.26, use module pygeodesy.rhumb.solve instead.
pygeodesy.deprecated.rhumbx: DEPRECATED on 2023.11.26, use module pygeodesy.rhumb.ekx instead.

Classes
	ClipCS3Tuple DEPRECATED, see DEPRECATED function pygeodesy.deprecated.clipCS3.
	Curvature2Tuple 2-Tuple `(meridional, prime_vertical)` of radii of curvature, both in `meter`, conventionally.
	Datum Ellipsoid and transform parameters for an earth model.
	EasNorExact4Tuple DEPRECATED, use class Forward4Tuple, item `gamma` for `convergence`.
	Ellipsoid Ellipsoid with equatorial and polar radii, flattening, inverse flattening and other, often used, cached attributes, supporting oblate and prolate ellipsoidal and spherical earth models.
	Helmert7Tuple DEPRECATED on 2024.02.02, use class TRFXform7Tuple, without keyword arguments.
	LatLonExact4Tuple DEPRECATED, use class Reverse4Tuple, item `gamma` for `convergence`.
	LatLonHeightBase 'DEPRECATED on 2021.02.10, use (INTERNAL) class pygeodesy.latlonBase.LatLonBase.
	LatLonNvectorBase (INTERNAL) Base class for n-vector-based ellipsoidal and spherical `LatLon` classes.
	NearestOn4Tuple DEPRECATED on 2023.10.10, see methods RhumbLine.nearestOn4 and RhumbLineAux.nearestOn4.
	Ned3Tuple DEPRECATED, use class Ned4Tuple, ignoring item `ltp`.
	Nvector DEPRECATED on 2021.05.20, see (INTERNAL) class pygeodesy.nvectorBase.NvectorBase.
	Rhumb7Tuple DEPRECATED, use class Rhumb8Tuple, ignoring item `a12`.
	RhumbOrder2Tuple DEPRECATED, see deprecated method Rhumb.orders.
	Transform Helmert datum transformation.
	Transform7Tuple DEPRECATED on 2024.02.02, use class TRFXform7Tuple, without keyword arguments.
	TriAngle4Tuple DEPRECATED on 2023.09.14, use class TriAngle5Tuple, ignoring item `area`.
	UtmUps4Tuple DEPRECATED and OBSOLETE, expect a UtmUps5Tuple from method `pygeodesy.Mgrs.toUtm(utm=None)`.

Functions

EcefCartesian(*args, **kwds)
DEPRECATED, use class LocalCartesian.

Fn_rt(root, *xs, **name_RESIDUAL_raiser)
DEPRECATED on 2024.04.17, use class Froot.

HeightIDW(knots, **kwds)
DEPRECATED, use class HeightIDWeuclidean.

HeightIDW2(knots, **kwds)
DEPRECATED, use class HeightIDWequirectangular.

HeightIDW3(knots, **kwds)
DEPRECATED, use class HeightIDWhaversine.

RefFrameError(*args, **kwds)
DEPRECATED, use class TRFError.

anStr(name, OKd='._-', sub='_')
DEPRECATED, use function pygeodesy.anstr.

areaof(points, adjust=True, radius=6371008.771415, wrap=True)
DEPRECATED, use function pygeodesy.areaOf.

atand(x)
DEPRECATED on 2023.09.28, use function pygeodesy.atan1d.

bounds(points, wrap=True, LatLon=None)
DEPRECATED, use function pygeodesy.boundsOf.

clipCS3(points, lowerleft, upperright, closed=False, inull=False)
DEPRECATED, use function pygeodesy.clipCS4.

clipDMS(deg, limit)
DEPRECATED, use function pygeodesy.clipDegrees.

clipStr(bstr, limit=50, white='')
DEPRECATED, use function pygeodesy.clips.

collins(pointA, pointB, pointC, alpha, beta, **useZ_Clas_and_kwds)
DEPRECATED, use function pygeodesy.collins5.

copysign(x, y)
DEPRECATED, use function pygeodesy.copysign0.

decodeEPSG2(arg)
DEPRECATED, use function epsg.decode2.

enStr2(easting, northing, prec, *extras)
DEPRECATED, use function pygeodesy.enstr2.

encodeEPSG(zone, hemipole='', band='')
DEPRECATED, use function epsg.encode.

equirectangular3(lat1, lon1, lat2, lon2, **options)
DEPRECATED, use function pygeodesy.equirectangular_.

excessAbc(A, b, c)
DEPRECATED on 2023.04.04, use function pygeodesy.excessAbc_.

excessGirard(A, B, C)
DEPRECATED on 2023.04.04, use function pygeodesy.excessGirard_.

excessLHuilier(a, b, c)
DEPRECATED on 2023.04.04, use function pygeodesy.excessLHuilier_.

fStr(floats, prec=6, fmt='f', ints=False, sep=', ')
DEPRECATED, use function fstr.

fStrzs(floatstr)
DEPRECATED, use function pygeodesy.fstrzs.

false2f(value, name='value', false=True, Error=<type 'exceptions.ValueError'>)
DEPRECATED, use class Easting or Northing.

falsed2f(falsed=True, Error=<type 'exceptions.ValueError'>, **name_value)
DEPRECATED, use class Easting or Northing.

float0(*xs)
DEPRECATED on 2023.04.21, use function pygeodesy.float0_.

hypot3(x, y, z)
DEPRECATED, use function pygeodesy.hypot_.

inStr(inst, *args, **kwds)
DEPRECATED, use function pygeodesy.instr.

isenclosedby(point, points, wrap=False)
DEPRECATED, use function pygeodesy.isenclosedBy.

istuplist(obj, minum=0)
DEPRECATED on 2023.03.31, use function pygeodesy.islistuple.

joined(*words, **sep)
DEPRECATED, use NN(...), NN.join_ or sep.join.

joined_(*words, **sep)
DEPRECATED, use _SPACE_(...), _SPACE_.join_ or sep.join, sep=" ".

nearestOn3(point, points, closed=False, wrap=False, **options)
DEPRECATED, use function pygeodesy.nearestOn5.

nearestOn4(point, points, closed=False, wrap=False, **options)
DEPRECATED, use function pygeodesy.nearestOn5.

parseUTM(strUTM, datum=_UTM, Utm=_UTM, name='')
DEPRECATED, use function parseUTM5.

perimeterof(points, closed=False, adjust=True, radius=6371008.771415, wrap=True)
DEPRECATED, use function pygeodesy.perimeterOf.

points2(points, closed=True, base=None, Error=<class 'pygeodesy.errors.PointsError'>)
Check a path or polygon represented by points.

polygon(points, closed=True, base=None)
DEPRECATED, use function pygeodesy.points2.

scalar(value, low=2.220446049250313e-16, high=1.0, name='scalar', Error=<type 'exceptions.ValueError'>)
DEPRECATED, use class Number_ or Scalar_.

simplify2(points, pipe, radius=6371008.771415, shortest=False, indices=False, **options)
DEPRECATED, use function pygeodesy.simplifyRW.

sumOf(nvectors, Vector=None, h=None, **Vector_kwds)
Return the vectorial sum of two or more n-vectors.

tienstra(pointA, pointB, pointC, alpha, **beta_gamma_useZ_Clas_and_kwds)
DEPRECATED, use function pygeodesy.tienstra7.

toUtm(latlon, lon=None, datum=None, Utm=_UTM, cmoff=True, name='')
DEPRECATED, use function pygeodesy.toUtm8.

triAngle4(a, b, c)
DEPRECATED on 2023.09.14, use function pygeodesy.triAngle5.

unStr(name, *args, **kwds)
DEPRECATED, use function pygeodesy.unstr.

unsign0(x)
DEPRECATED, use function pygeodesy.unsigned0.

utmZoneBand2(lat, lon)
DEPRECATED, use function pygeodesy.utmZoneBand5.

Variables
	__getattr__ = `_lazy_import_as(__name__)`
	Datums = `Datums.OSGB36: Datum(name='OSGB36', ellipsoid=Ellipso...`
	EPS1_2 = `0.9999999999999999`
	Ellipsoids = `Ellipsoids.Sphere: Ellipsoid(name='Sphere', a=637...`
	MANTIS = `53`
	NorthPole = `NvectorBase(0.0, 0.0, 1.0)`
	OK = `'OK'`
	R_FM = `6371000.0`
	R_KM = `6371.0087714149995`
	R_M = `6371008.771415`
	R_MA = `6378137.0`
	R_MB = `6356752.3`
	R_NM = `3440.06953100162`
	R_SM = `3958.7613160486508`
	R_VM = `6366707.0194937`
	SouthPole = `NvectorBase(0.0, 0.0, -1.0)`
	Transforms = `Transforms.OSGB36: Transform(name='OSGB36', tx=-4...`

Function Details

anStr (name, OKd=`'._-'`, sub='_')

DEPRECATED, use function pygeodesy.anstr.

Decorators:

@deprecated_function

areaof (points, adjust=True, radius=6371008.771415, wrap=True)

DEPRECATED, use function pygeodesy.areaOf.

Decorators:

@deprecated_function

atand (x)

DEPRECATED on 2023.09.28, use function pygeodesy.atan1d.

Decorators:

@deprecated_function

bounds (points, wrap=True, LatLon=None)

DEPRECATED, use function pygeodesy.boundsOf.

Returns:

2-Tuple (latlonSW, latlonNE) as LatLon or 4-Tuple

(latS, lonW, latN, 
          lonE)

if LatLon is None.

Decorators:

@deprecated_function

clipCS3 (points, lowerleft, upperright, closed=False, inull=False)

DEPRECATED, use function pygeodesy.clipCS4.

Returns:

Yield a ClipCS3Tuple(start, end, index) for each edge of the clipped path.

Decorators:

@deprecated_function

clipDMS (deg, limit)

DEPRECATED, use function pygeodesy.clipDegrees.

Decorators:

@deprecated_function

clipStr (bstr, limit=50, white='')

DEPRECATED, use function pygeodesy.clips.

Decorators:

@deprecated_function

collins (pointA, pointB, pointC, alpha, beta, **useZ_Clas_and_kwds)

DEPRECATED, use function pygeodesy.collins5.

Decorators:

@deprecated_function

copysign (x, y)

DEPRECATED, use function pygeodesy.copysign0.

Decorators:

@deprecated_function

decodeEPSG2 (arg)

DEPRECATED, use function epsg.decode2.

Returns:

2-Tuple (zone, hemipole)

Decorators:

@deprecated_function

enStr2 (easting, northing, prec, *extras)

DEPRECATED, use function pygeodesy.enstr2.

Decorators:

@deprecated_function

encodeEPSG (zone, hemipole='', band='')

DEPRECATED, use function epsg.encode.

Returns:

EPSG code (int).

Decorators:

@deprecated_function

equirectangular3 (lat1, lon1, lat2, lon2, **options)

DEPRECATED, use function pygeodesy.equirectangular_.

Returns:

3-Tuple (distance2, delta_lat, delta_lon).

Decorators:

@deprecated_function

excessAbc (A, b, c)

DEPRECATED on 2023.04.04, use function pygeodesy.excessAbc_.

Decorators:

@deprecated_function

excessGirard (A, B, C)

DEPRECATED on 2023.04.04, use function pygeodesy.excessGirard_.

Decorators:

@deprecated_function

excessLHuilier (a, b, c)

DEPRECATED on 2023.04.04, use function pygeodesy.excessLHuilier_.

Decorators:

@deprecated_function

fStr (floats, prec=6, fmt='f', ints=False, sep=', ')

DEPRECATED, use function fstr.

Decorators:

@deprecated_function

fStrzs (floatstr)

DEPRECATED, use function pygeodesy.fstrzs.

Decorators:

@deprecated_function

false2f (value, name=`'value'`, false=True, Error=<type 'exceptions.ValueError'>)

DEPRECATED, use class Easting or Northing.

Decorators:

@deprecated_function

falsed2f (falsed=True, Error=<type 'exceptions.ValueError'>, **name_value)

DEPRECATED, use class Easting or Northing.

Convert a falsed east-/northing to non-negative float.

Arguments:

falsed - Value includes false origin (bool).
Error - Optional, overriding error (Exception).
name_value - One name=value pair.

Returns:

The value (float).

Decorators:

@deprecated_function

Raises:

Error - Invalid or negative name=value.

float0 (*xs)

DEPRECATED on 2023.04.21, use function pygeodesy.float0_.

Decorators:

@deprecated_function

hypot3 (x, y, z)

DEPRECATED, use function pygeodesy.hypot_.

Decorators:

@deprecated_function

inStr (inst, *args, **kwds)

DEPRECATED, use function pygeodesy.instr.

Decorators:

@deprecated_function

isenclosedby (point, points, wrap=False)

DEPRECATED, use function pygeodesy.isenclosedBy.

Decorators:

@deprecated_function

istuplist (obj, minum=0)

DEPRECATED on 2023.03.31, use function pygeodesy.islistuple.

Decorators:

@deprecated_function

joined (*words, **sep)

DEPRECATED, use NN(...), NN.join_ or sep.join.

Decorators:

@deprecated_function

joined_ (*words, **sep)

DEPRECATED, use _SPACE_(...), _SPACE_.join_ or sep.join, sep=" ".

Decorators:

@deprecated_function

nearestOn3 (point, points, closed=False, wrap=False, **options)

DEPRECATED, use function pygeodesy.nearestOn5.

Returns:

3-Tuple (lat, lon, distance)

Decorators:

@deprecated_function

nearestOn4 (point, points, closed=False, wrap=False, **options)

DEPRECATED, use function pygeodesy.nearestOn5.

Returns:

4-Tuple (lat, lon, distance, angle)

Decorators:

@deprecated_function

parseUTM (strUTM, datum=_UTM, Utm=_UTM, name='')

DEPRECATED, use function parseUTM5.

Returns:

The UTM coordinate (Utm) or 4-tuple

(zone, hemisphere, 
          easting, northing)

if Utm is None.

Decorators:

@deprecated_function

perimeterof (points, closed=False, adjust=True, radius=6371008.771415, wrap=True)

DEPRECATED, use function pygeodesy.perimeterOf.

Decorators:

@deprecated_function

points2 (points, closed=True, base=None, Error=<class 'pygeodesy.errors.PointsError'>)

Check a path or polygon represented by points.

Arguments:

points - The path or polygon points (LatLon[])
closed - Optionally, consider the polygon closed, ignoring any duplicate or closing final points (bool).
base - Optionally, check all points against this base class, if None don't check.
Error - Exception to raise (ValueError).

Returns:

A Points2Tuple(number, points) with the number of points and the points list or tuple.

Raises:

PointsError - Insufficient number of points.
TypeError - Some points are not base compatible or composite points.

polygon (points, closed=True, base=None)

DEPRECATED, use function pygeodesy.points2.

Decorators:

@deprecated_function

scalar (value, low=2.220446049250313e-16, high=1.0, name=`'scalar'`, Error=<type 'exceptions.ValueError'>)

DEPRECATED, use class Number_ or Scalar_.

Returns:

New value (float or int for int low).

Decorators:

@deprecated_function

Raises:

Error - Invalid value.

simplify2 (points, pipe, radius=6371008.771415, shortest=False, indices=False, **options)

DEPRECATED, use function pygeodesy.simplifyRW.

Decorators:

@deprecated_function

sumOf (nvectors, Vector=None, h=None, **Vector_kwds)

Return the vectorial sum of two or more n-vectors.

Arguments:

nvectors - Vectors to be added (Nvector[]).
Vector - Optional class for the vectorial sum (Nvector) or None.
h - Optional height, overriding the mean height (meter).
Vector_kwds - Optional, additional Vector keyword arguments, ignored if Vector is None.

Returns:

Vectorial sum (Vector) or a Vector4Tuple(x, y, z, h) if Vector is None.

Raises:

VectorError - No nvectors.

tienstra (pointA, pointB, pointC, alpha, **beta_gamma_useZ_Clas_and_kwds)

DEPRECATED, use function pygeodesy.tienstra7.

Decorators:

@deprecated_function

toUtm (latlon, lon=None, datum=None, Utm=_UTM, cmoff=True, name='')

DEPRECATED, use function pygeodesy.toUtm8.

Returns:

The UTM coordinate (Utm) or a 6-tuple (zone, easting, northing, band, convergence, scale) if Utm is None or cmoff is False.

Decorators:

@deprecated_function

triAngle4 (a, b, c)

DEPRECATED on 2023.09.14, use function pygeodesy.triAngle5.

Returns:

A DEPRECATED TriAngle4Tuple

(radA, radB, radC, 
          rIn)

Decorators:

@deprecated_function

unStr (name, *args, **kwds)

DEPRECATED, use function pygeodesy.unstr.

Decorators:

@deprecated_function

unsign0 (x)

DEPRECATED, use function pygeodesy.unsigned0.

Decorators:

@deprecated_function

utmZoneBand2 (lat, lon)

DEPRECATED, use function pygeodesy.utmZoneBand5.

Returns:

2-Tuple (zone, band).

Decorators:

@deprecated_function

Variables Details

Datums

Value:

Datums.OSGB36: Datum(name='OSGB36', ellipsoid=Ellipsoids.Airy1830, tra
nsform=Transforms.OSGB36),
Datums.GRS80: Datum(name='GRS80', ellipsoid=Ellipsoids.GRS80, transfor
m=Transforms.WGS84),
Datums.WGS84: Datum(name='WGS84', ellipsoid=Ellipsoids.WGS84, transfor
m=Transforms.WGS84),
Datums.Sphere: Datum(name='Sphere', ellipsoid=Ellipsoids.Sphere, trans
form=Transforms.WGS84)

Ellipsoids

Value:

Ellipsoids.Sphere: Ellipsoid(name='Sphere', a=6371008.771415, b=637100
8.771415, f_=0, f=0, f2=0, n=0, e=0, e2=0, e21=1, e22=0, e32=0, A=6371
008.771415, L=10007557.17611675, R1=6371008.771415, R2=6371008.771415,
 R3=6371008.771415, Rbiaxial=6371008.771415, Rtriaxial=6371008.771415)
,
Ellipsoids.GRS80: Ellipsoid(name='GRS80', a=6378137, b=6356752.3141403
5, f_=298.2572221, f=0.00335281, f2=0.00336409, n=0.00167922, e=0.0818
1919, e2=0.00669438, e21=0.99330562, e22=0.0067395, e32=0.00335843, A=
...

Transforms

Value:

Transforms.OSGB36: Transform(name='OSGB36', tx=-446.45, ty=125.16, tz=
-542.06, s1=1.0, rx=-7.2819e-07, ry=-1.1975e-06, rz=-4.0826e-06, s=20.
489, sx=-0.1502, sy=-0.247, sz=-0.8421),
Transforms.WGS84: Transform(name='WGS84', tx=0.0, ty=0.0, tz=0.0, s1=1
.0, rx=0.0, ry=0.0, rz=0.0, s=0.0, sx=0.0, sy=0.0, sz=0.0),
Transforms.Identity: Transform(name='Identity', tx=0.0, ty=0.0, tz=0.0
, s1=1.0, rx=0.0, ry=0.0, rz=0.0, s=0.0, sx=0.0, sy=0.0, sz=0.0)

Package deprecated

anStr (name, OKd='._-', sub='_')

areaof (points, adjust=True, radius=6371008.771415, wrap=True)

atand (x)

bounds (points, wrap=True, LatLon=None)

clipCS3 (points, lowerleft, upperright, closed=False, inull=False)

clipDMS (deg, limit)

clipStr (bstr, limit=50, white='')

collins (pointA, pointB, pointC, alpha, beta, **useZ_Clas_and_kwds)

copysign (x, y)

decodeEPSG2 (arg)

enStr2 (easting, northing, prec, *extras)

encodeEPSG (zone, hemipole='', band='')

equirectangular3 (lat1, lon1, lat2, lon2, **options)

excessAbc (A, b, c)

excessGirard (A, B, C)

excessLHuilier (a, b, c)

fStr (floats, prec=6, fmt='f', ints=False, sep=', ')

fStrzs (floatstr)

false2f (value, name='value', false=True, Error=<type 'exceptions.ValueError'>)

falsed2f (falsed=True, Error=<type 'exceptions.ValueError'>, **name_value)

float0 (*xs)

hypot3 (x, y, z)

inStr (inst, *args, **kwds)

isenclosedby (point, points, wrap=False)

istuplist (obj, minum=0)

joined (*words, **sep)

joined_ (*words, **sep)

nearestOn3 (point, points, closed=False, wrap=False, **options)

nearestOn4 (point, points, closed=False, wrap=False, **options)

parseUTM (strUTM, datum=_UTM, Utm=_UTM, name='')

perimeterof (points, closed=False, adjust=True, radius=6371008.771415, wrap=True)

points2 (points, closed=True, base=None, Error=<class 'pygeodesy.errors.PointsError'>)

polygon (points, closed=True, base=None)

scalar (value, low=2.220446049250313e-16, high=1.0, name='scalar', Error=<type 'exceptions.ValueError'>)

simplify2 (points, pipe, radius=6371008.771415, shortest=False, indices=False, **options)

sumOf (nvectors, Vector=None, h=None, **Vector_kwds)

tienstra (pointA, pointB, pointC, alpha, **beta_gamma_useZ_Clas_and_kwds)

toUtm (latlon, lon=None, datum=None, Utm=_UTM, cmoff=True, name='')

triAngle4 (a, b, c)

unStr (name, *args, **kwds)

unsign0 (x)

utmZoneBand2 (lat, lon)

Datums

Ellipsoids

Transforms

anStr (name, OKd=`'._-'`, sub='_')

false2f (value, name=`'value'`, false=True, Error=<type 'exceptions.ValueError'>)

scalar (value, low=2.220446049250313e-16, high=1.0, name=`'scalar'`, Error=<type 'exceptions.ValueError'>)