Package pygeodesy :: Module deprecated
[frames] | no frames]

Module deprecated

DEPRECATED classes, functions, etc. exported for backward compatibility.


Version: 20.09.22

Classes
  HeightIDW
DEPRECATED, use class HeightIDWeuclidean.
  HeightIDW2
DEPRECATED, use class HeightIDWequirectangular.
  HeightIDW3
DEPRECATED, use class HeightIDWhaversine.
  RefFrameError
DEPRECATED, use class TRFError.
  UtmUps4Tuple
OBSOLETE, expect a UtmUps5Tuple from method Mgrs.toUtm(utm=None).
Functions
 
anStr(name, OKd='._-', sub='_')
DEPRECATED, use function anstr.
 
areaof(points, adjust=True, radius=_R_M, wrap=True)
DEPRECATED, use function areaOf.
 
bounds(points, wrap=True, LatLon=None)
DEPRECATED, use function boundsOf.
 
clipDMS(deg, limit)
DEPRECATED, use function clipDegrees.
 
clipStr(bstr, limit=50, white='')
DEPRECATED, use function clips.
 
decodeEPSG2(arg)
DEPRECATED, use function epsg.decode2.
 
encodeEPSG(zone, hemipole='', band='')
DEPRECATED, use function epsg.encode.
 
enStr2(easting, northing, prec, *extras)
DEPRECATED, use function enstr2.
 
equirectangular3(lat1, lon1, lat2, lon2, **options)
DEPRECATED, use function equirectangular_.
 
false2f(value, name='value', false=True, Error=<type 'exceptions.ValueError'>)
DEPRECATED, use function falsed2f.
 
falsed2f(falsed=True, Error=<type 'exceptions.ValueError'>, **name_value)
DEPRECATED, use class Easting or Northing.
 
fStr(floats, prec=6, fmt='%.*f', ints=False, sep=', ')
DEPRECATED, use function fstr.
 
fStrzs(floatstr)
DEPRECATED, use function fstrzs.
 
hypot3(x, y, z)
DEPRECATED, use function hypot_.
 
inStr(inst, *args, **kwds)
DEPRECATED, use function instr.
 
isenclosedby(point, points, wrap=False)
DEPRECATED, use function isenclosedBy.
 
nearestOn3(point, points, closed=False, wrap=False, **options)
DEPRECATED, use function nearestOn5.
 
nearestOn4(point, points, closed=False, wrap=False, **options)
DEPRECATED, use function nearestOn5.
 
parseUTM(strUTM, datum=_R_M, Utm=_R_M, name='')
DEPRECATED, use function parseUTM5.
 
perimeterof(points, closed=False, adjust=True, radius=_R_M, wrap=True)
DEPRECATED, use function perimeterOf.
 
polygon(points, closed=True, base=None)
DEPRECATED, use function points2.
 
scalar(value, low=2.22044604925e-16, high=1.0, name='scalar', Error=<type 'exceptions.ValueError'>)
DEPRECATED, use class Number_ or Scalar_.
 
simplify2(points, pipe, radius=_R_M, shortest=False, indices=False, **options)
DEPRECATED, use function simplifyRW.
 
toUtm(latlon, lon=None, datum=None, Utm=_R_M, cmoff=True, name='')
DEPRECATED, use function toUtm8.
 
unStr(name, *args, **kwds)
DEPRECATED, use function unstr.
 
utmZoneBand2(lat, lon)
DEPRECATED, use function utmZoneBand5.
Variables
  __all__ = _ALL_LAZY.deprecated
  OK = 'OK'
Function Details

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

 

DEPRECATED, use function boundsOf.

Returns:
2-Tuple (latlonSW, latlonNE) as LatLon or 4-Tuple (latS, lonW, latN, lonE) if LatLon is None.

decodeEPSG2 (arg)

 

DEPRECATED, use function epsg.decode2.

Returns:
2-Tuple (zone, hemipole)

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

 

DEPRECATED, use function epsg.encode.

Returns:
EPSG code (int).

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

 

DEPRECATED, use function equirectangular_.

Returns:
3-Tuple (distance2, delta_lat, delta_lon).

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).
Raises:
  • Error - Invalid or negative name=value.

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

 

DEPRECATED, use function nearestOn5.

Returns:
3-Tuple (lat, lon, distance)

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

 

DEPRECATED, use function nearestOn5.

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

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

 

DEPRECATED, use function parseUTM5.

Returns:
The UTM coordinate (Utm) or 4-tuple (zone, hemisphere, easting, northing) if Utm is None.

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

 

DEPRECATED, use class Number_ or Scalar_.

Arguments:
  • value - The value (scalar).
  • low - Optional lower bound (scalar).
  • high - Optional upper bound (scalar).
  • name - Optional name of value (str).
  • Error - Exception to raise (ValueError).
Returns:
New value (float or int for int low).
Raises:
  • Error - Invalid value.

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

 

DEPRECATED, use function toUtm8.

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

utmZoneBand2 (lat, lon)

 

DEPRECATED, use function utmZoneBand5.

Returns:
2-Tuple (zone, band).