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

# Package deprecated

DEPRECATED classes, functions, methods, etc.

Kept and exported for backward compatibility, including deprecated modules `pygeodesy.bases`, `pygeodesy.datum` and `pygeodesy,nvector`, previously inside the `pygeodesy` package.

Use either `from pygeodesy import bases` or `from pygeodesy.deprecated import bases`. Likewise for `datum` and `nvector`.

Version: 21.06.10

Submodules
pygeodesy.deprecated.bases: DEPRECATED, use module latlonBase instead. pygeodesy.deprecated.datum: DEPRECATED, use module datums or ellipsoids instead. pygeodesy.deprecated.nvector: DEPRECATED, use module nvectorBase instead.

Classes
| ClipCS3Tuple 3-Tuple `(start, end, index)`.
| EcefCartesian DEPRECATED, use class LocalCartesian.
| 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=6371008.77141, wrap=True) DEPRECATED, use function areaOf. |
bounds(points, wrap=True, LatLon=None) DEPRECATED, use function boundsOf. |
clipCS3(points, lowerleft, upperright, closed=False, inull=False) DEPRECATED, use function clipCS4. |
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. |
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 nearestOn5. |
nearestOn4(point, points, closed=False, wrap=False, **options) DEPRECATED, use function nearestOn5. |
parseUTM(strUTM, datum=_UTM, Utm=_UTM, name='') DEPRECATED, use function parseUTM5. |
perimeterof(points, closed=False, adjust=True, radius=6371008.77141, 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=6371008.77141, shortest=False, indices=False, **options) DEPRECATED, use function simplifyRW. |
toUtm(latlon, lon=None, datum=None, Utm=_UTM, 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

### anStr (name, OKd=`'``._-``'`, sub='_') |
DEPRECATED, use function anstr. Decorators: `@deprecated_function`

### areaof (points, adjust=True, radius=6371008.77141, wrap=True) |
DEPRECATED, use function areaOf. Decorators: `@deprecated_function`

### 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`. Decorators: `@deprecated_function`

### clipCS3 (points, lowerleft, upperright, closed=False, inull=False) |
DEPRECATED, use function clipCS4. Returns: Yield a ClipCS3Tuple`(start, end, index)` for each edge of the clipped path. Decorators: `@deprecated_function`

### clipDMS (deg, limit) |
DEPRECATED, use function clipDegrees. Decorators: `@deprecated_function`

### clipStr (bstr, limit=50, white='') |
DEPRECATED, use function clips. Decorators: `@deprecated_function`

### decodeEPSG2 (arg) |
DEPRECATED, use function epsg.decode2. Returns: 2-Tuple `(zone, hemipole)` Decorators: `@deprecated_function`

### encodeEPSG (zone, hemipole='', band='') |
DEPRECATED, use function epsg.encode. Returns: `EPSG` code (`int`). Decorators: `@deprecated_function`

### enStr2 (easting, northing, prec, *extras) |
DEPRECATED, use function enstr2. Decorators: `@deprecated_function`

### equirectangular3 (lat1, lon1, lat2, lon2, **options) |
DEPRECATED, use function `equirectangular_`. Returns: 3-Tuple `(distance2, delta_lat, delta_lon)`. Decorators: `@deprecated_function`

### false2f (value, name=`'``value``'`, false=True, Error=<type 'exceptions.ValueError'>) |
DEPRECATED, use function falsed2f. 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`.

### fStr (floats, prec=6, fmt='f', ints=False, sep=', ') |
DEPRECATED, use function fstr. Decorators: `@deprecated_function`

### fStrzs (floatstr) |
DEPRECATED, use function fstrzs. Decorators: `@deprecated_function`

### hypot3 (x, y, z) |
DEPRECATED, use function hypot_. Decorators: `@deprecated_function`

### inStr (inst, *args, **kwds) |
DEPRECATED, use function instr. Decorators: `@deprecated_function`

### isenclosedby (point, points, wrap=False) |
DEPRECATED, use function isenclosedBy. 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 nearestOn5. Returns: 3-Tuple `(lat, lon, distance)` Decorators: `@deprecated_function`

### nearestOn4 (point, points, closed=False, wrap=False, **options) |
DEPRECATED, use function 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.77141, wrap=True) |
DEPRECATED, use function perimeterOf. Decorators: `@deprecated_function`

### polygon (points, closed=True, base=None) |
DEPRECATED, use function points2. Decorators: `@deprecated_function`

### scalar (value, low=2.22044604925e-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.77141, shortest=False, indices=False, **options) |
DEPRECATED, use function simplifyRW. Decorators: `@deprecated_function`

### toUtm (latlon, lon=None, datum=None, Utm=_UTM, 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`. Decorators: `@deprecated_function`

### unStr (name, *args, **kwds) |
DEPRECATED, use function unstr. Decorators: `@deprecated_function`

### utmZoneBand2 (lat, lon) |
DEPRECATED, use function utmZoneBand5. Returns: 2-Tuple `(zone, band)`. Decorators: `@deprecated_function`