Coverage for pygeodesy/deprecated/__init__.py : 98%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
# -*- coding: utf-8 -*-
Kept and exported for backward compatibility, including deprecated modules C{pygeodesy.bases}, C{pygeodesy.datum} and C{pygeodesy,nvector}, previously inside the C{pygeodesy} package.
Use either C{from pygeodesy import bases} or C{from pygeodesy.deprecated import bases}. Likewise for C{datum} and C{nvector}. '''
_DEPRECATED_, _down_, _east_, _easting_, _end_, \ _hemipole_, _lat_, _lat1_, _lat2_, _lon_, _lon1_, \ _lon2_, _negative_, _north_, _northing_, _s_, \ _s12_, _S12_, _scalar_, _scale_, _sep_, _SPACE_, \ _start_, _sx_, _sy_, _sz_, _tx_, _ty_, _tz_, \ _UNDER_, _value_, _zone_ Number_, Scalar, Scalar_, Str pygeodesy.deprecated.datum as datum, \ pygeodesy.deprecated.nvector as nvector # PYCHOK unused # XXX instead, use module_property or enhance .lazily
'''DEPRECATED, don't use.'''
'''DEPRECATED, don't use.'''
'''DEPRECATED, don't use.'''
'''(INTERNAL) Base class for DEPRECATED C{_NamedTuple} classes. '''
# DEPRECATED classes, for export and backward compatibility only class ClipCS3Tuple(_DeprecatedNamedTuple): # PYCHOK no cover '''DEPRECATED, see function L{pygeodesy.clipCS3}.''' _Names_ = (_start_, _end_, 'index') _Units_ = (_Pass, _Pass, Number_)
'''DEPRECATED, use class L{LocalCartesian}.'''
'''DEPRECATED, use class L{LocalCartesian}.
@note: This class is named I{incorrectly}, since it provides conversion to and from I{local} cartesian coordinates in a I{local tangent plane} and I{not geocentric} (ECEF) ones, as the name suggests. '''
'''DEPRECATED, use method L{LocalCartesian.forward}.
@return: I{Incorrectly}, an L{Ecef9Tuple}C{(x, y, z, lat, lon, height, C, M, datum)} with I{local} C{(x, y, z)} coordinates for the given I{geodetic} ones C{(lat, lon, height)}, case C{C=0} always, optionally I{concatenated} L{EcefMatrix} C{M} and C{datum}. ''' 0, t.M, t.ecef.datum, name=t.name or self.name)
'''DEPRECATED, use method L{LocalCartesian.reverse}.
@return: I{Incorrectly}, an L{Ecef9Tuple}C{(x, y, z, lat, lon, height, C, M, datum)} with I{geodetic} coordinates C{(lat, lon, height)} for the given I{local} ones C{(x, y, z)}, case C{C}, optionally I{concatenated} L{EcefMatrix} C{M} and C{datum}. ''' t.ecef.C, t.M, t.ecef.datum, name=t.name or self.name)
'''DEPRECATED, use class L{Forward4Tuple}.'''
def HeightIDW(knots, **kwds): # PYCHOK no cover '''DEPRECATED, use class L{HeightIDWeuclidean}.''' HeightIDWeuclidean = _MODS.heights.HeightIDWeuclidean
class HeightIDW(HeightIDWeuclidean): '''DEPRECATED, use class L{HeightIDWeuclidean}.''' def __init__(self, knots, adjust=True, beta=2, name=NN): deprecated_class(self.__class__) HeightIDWeuclidean.__init__(self, knots, adjust=adjust, beta=beta, name=name)
_MODS.deprecated.HeightIDW = HeightIDW return HeightIDW(knots, **kwds)
def HeightIDW2(knots, **kwds): # PYCHOK no cover '''DEPRECATED, use class L{HeightIDWequirectangular}.''' HeightIDWequirectangular = _MODS.heights.HeightIDWequirectangular
class HeightIDW2(HeightIDWequirectangular): '''DEPRECATED, use class L{HeightIDWequirectangular}.''' def __init__(self, knots, adjust=True, wrap=False, name=NN): deprecated_class(self.__class__) HeightIDWequirectangular.__init__(self, knots, adjust=adjust, wrap=wrap, name=name)
_MODS.deprecated.HeightIDW2 = HeightIDW2 return HeightIDW2(knots, **kwds)
def HeightIDW3(knots, **kwds): # PYCHOK no cover '''DEPRECATED, use class L{HeightIDWhaversine}.''' HeightIDWhaversine = _MODS.heights.HeightIDWhaversine
class HeightIDW3(HeightIDWhaversine): '''DEPRECATED, use class L{HeightIDWhaversine}. ''' def __init__(self, knots, beta=2, wrap=False, name=NN): deprecated_class(self.__class__) HeightIDWhaversine.__init__(self, knots, beta=beta, wrap=wrap, name=name)
_MODS.deprecated.HeightIDW3 = HeightIDW3 return HeightIDW3(knots, **kwds)
'''DEPRECATED, used class L{Reverse4Tuple}.'''
'''DEPRECATED, use class L{pygeodesy.Ned4Tuple}.'''
def RefFrameError(*args, **kwds): # PYCHOK no cover '''DEPRECATED, use class L{TRFError}.''' TRFError = _MODS.errors.TRFError
class RefFrameError(TRFError): '''DEPRECATED, use class L{TRFError}. ''' def __init__(self, *name_value, **txt_name_values): deprecated_class(self.__class__) TRFError.__init__(self, *name_value, **txt_name_values)
_MODS.deprecated.RefFrameError = RefFrameError return RefFrameError(*args, **kwds)
'''DEPRECATED, use class L{Rhumb8Tuple} ignoring item C{a12}.'''
return self.toRhumb8Tuple().toGDict(**kwds)
'''(INTERNAL) see L{Rhumb8Tuple._to7Tuple}. ''' return self
class Transform7Tuple(_DeprecatedNamedTuple): # PYCHOK no cover '''DEPRECATED, use class L{Helmert7Tuple} without keyword arguments.''' _Names_ = (_tx_, _ty_, _tz_, _s_, _sx_, _sy_, _sz_) _Units_ = ( Float, Float, Float, Float, Float, Float, Float)
def __new__(cls, tx=0, ty=0, tz=0, s=0, sx=0, sy=0, sz=0, name=NN): t = map(_float, (tx, ty, tz, s, sx, sy, sz)) return _DeprecatedNamedTuple.__new__(cls, *t, name=name)
class UtmUps4Tuple(_DeprecatedNamedTuple): # PYCHOK no cover '''DEPRECATED and OBSOLETE, expect a L{UtmUps5Tuple} from method C{Mgrs.toUtm(utm=None)}.
4-Tuple C{(zone, hemipole, easting, northing)} as C{str}, C{str}, C{meter} and C{meter}. ''' _Names_ = (_zone_, _hemipole_, _easting_, _northing_) # band _Units_ = ( Str, Str, Easting, Northing)
def anStr(name, OKd='._-', sub=_UNDER_): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.anstr}.''' return _MODS.streprs.anstr(name, OKd=OKd, sub=sub)
def areaof(points, adjust=True, radius=R_M, wrap=True): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.areaOf}.''' return _MODS.points.areaOf(points, adjust=adjust, radius=radius, wrap=wrap)
def bounds(points, wrap=True, LatLon=None): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.boundsOf}.
@return: 2-Tuple C{(latlonSW, latlonNE)} as B{C{LatLon}} or 4-Tuple C{(latS, lonW, latN, lonE)} if B{C{LatLon}} is C{None}. ''' return tuple(_MODS.points.boundsOf(points, wrap=wrap, LatLon=LatLon))
def clipCS3(points, lowerleft, upperright, closed=False, inull=False): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.clipCS4}.
@return: Yield a L{ClipCS3Tuple}C{(start, end, index)} for each edge of the I{clipped} path. ''' for p1, p2, _, j in _MODS.clipy.clipCS4(points, lowerleft, upperright, closed=closed, inull=inull): yield ClipCS3Tuple(p1, p2, j)
def clipDMS(deg, limit): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.clipDegrees}.''' return _MODS.dms.clipDegrees(deg, limit)
def clipStr(bstr, limit=50, white=NN): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.clips}.''' return _MODS.basics.clips(bstr, limit=limit, white=white)
'''DEPRECATED, use function L{pygeodesy.collins5}.'''
def copysign(x, y): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.copysign0}.''' return _MODS.basics.copysign0(x, y)
def decodeEPSG2(arg): # PYCHOK no cover '''DEPRECATED, use function L{epsg.decode2}.
@return: 2-Tuple C{(zone, hemipole)} ''' return tuple(_MODS.epsg.decode2(arg))
def encodeEPSG(zone, hemipole=NN, band=NN): # PYCHOK no cover '''DEPRECATED, use function L{epsg.encode}.
@return: C{EPSG} code (C{int}). ''' return int(_MODS.epsg.encode(zone, hemipole=hemipole, band=band))
def enStr2(easting, northing, prec, *extras): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.enstr2}.''' return _MODS.streprs.enstr2(easting, northing, (int(prec) // 2 - 5), *extras)
def equirectangular3(lat1, lon1, lat2, lon2, **options): # PYCHOK no cover '''DEPRECATED, use function C{equirectangular_}.
@return: 3-Tuple C{(distance2, delta_lat, delta_lon)}. ''' return tuple(_MODS.formy.equirectangular_(lat1, lon1, lat2, lon2, **options)[:3])
def false2f(value, name=_value_, false=True, Error=ValueError): # PYCHOK no cover '''DEPRECATED, use function L{falsed2f}.''' return falsed2f(falsed=false, Error=Error, **{name: value})
def falsed2f(falsed=True, Error=ValueError, **name_value): # PYCHOK no cover '''DEPRECATED, use class L{Easting} or L{Northing}.
Convert a falsed east-/northing to non-negative C{float}.
@kwarg falsed: Value includes false origin (C{bool}). @kwarg Error: Optional, overriding error (C{Exception}). @kwarg name_value: One C{B{name}=value} pair.
@return: The value (C{float}).
@raise Error: Invalid or negative C{B{name}=value}. ''' t = NN if len(name_value) == 1: try: for f in name_value.values(): f = float(f) if falsed and f < 0: break return f t = _COMMASPACE_('falsed', _negative_) except (TypeError, ValueError) as x: t = str(x) raise _MODS.errors._InvalidError(Error=Error, txt=t, **name_value)
def fStr(floats, prec=6, fmt=_MODS.streprs.Fmt.f, ints=False, sep=_COMMASPACE_): # PYCHOK no cover '''DEPRECATED, use function L{fstr}.''' return _MODS.streprs.fstr(floats, prec=prec, fmt=fmt, ints=ints, sep=sep)
def fStrzs(floatstr): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.fstrzs}.''' return _MODS.streprs.fstrzs(floatstr)
def hypot3(x, y, z): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.hypot_}.''' return _MODS.fmath.hypot_(x, y, z)
def inStr(inst, *args, **kwds): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.instr}.''' return _MODS.streprs.instr(inst, *args, **kwds)
'''Return C{True} if C{B{obj}} is a C{DEPRECATED} class, method or function, C{False} if not or C{None} if undetermined. ''' except AttributeError: return None
def isenclosedby(point, points, wrap=False): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.isenclosedBy}.''' return _MODS.points.isenclosedBy(point, points, wrap=wrap)
def joined(*words, **sep): # PYCHOK no cover '''DEPRECATED, use C{NN(...)}, C{NN.join_} or C{B{sep}.join}.''' return sep.get(_sep_, NN).join(map(str, words))
def joined_(*words, **sep): # PYCHOK no cover '''DEPRECATED, use C{_SPACE_(...)}, C{_SPACE_.join_} or C{B{sep}.join}, sep=" ".''' return sep.get(_sep_, _SPACE_).join(map(str, words))
def nearestOn3(point, points, closed=False, wrap=False, **options): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.nearestOn5}.
@return: 3-Tuple C{(lat, lon, distance)} ''' return tuple(_MODS.points.nearestOn5(point, points, closed=closed, wrap=wrap, **options)[:3])
def nearestOn4(point, points, closed=False, wrap=False, **options): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.nearestOn5}.
@return: 4-Tuple C{(lat, lon, distance, angle)} ''' return tuple(_MODS.points.nearestOn5(point, points, closed=closed, wrap=wrap, **options)[:4])
def parseUTM(strUTM, datum=_WGS84, Utm=_UTM, name=NN): # PYCHOK no cover '''DEPRECATED, use function L{parseUTM5}.
@return: The UTM coordinate (B{L{Utm}}) or 4-tuple C{(zone, hemisphere, easting, northing)} if B{C{Utm}} is C{None}. ''' d = _MODS.datums.Datums.WGS84 if datum is _WGS84 else datum # PYCHOK shadows? U = _MODS.utm.Utm if Utm is _UTM else Utm r = _MODS.utm.parseUTM5(strUTM, datum=d, Utm=U, name=name) if isinstance(r, tuple): # UtmUps5Tuple r = r.zone, r.hemipole, r.easting, r.northing # no band return r
def perimeterof(points, closed=False, adjust=True, radius=R_M, wrap=True): # PYCHOK no cover '''DEPRECATED, use function L{perimeterOf}.''' return _MODS.points.perimeterOf(points, closed=closed, adjust=adjust, radius=radius, wrap=wrap)
def polygon(points, closed=True, base=None): # PYCHOK no cover '''DEPRECATED, use function L{points2}.''' from pygeodesy.deprecated.bases import points2 # PYCHOK import return points2(points, closed=closed, base=base)
def scalar(value, low=EPS, high=1.0, name=_scalar_, Error=ValueError): # PYCHOK no cover '''DEPRECATED, use class L{Number_} or L{Scalar_}.
@return: New value (C{float} or C{int} for C{int} B{C{low}}).
@raise Error: Invalid B{C{value}}. ''' C_ = Number_ if _MODS.basics.isint(low) else Scalar_ return C_(value, name=name, Error=Error, low=low, high=high)
def simplify2(points, pipe, radius=R_M, shortest=False, indices=False, **options): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.simplifyRW}. ''' return _MODS.simplify.simplifyRW(points, pipe, radius=radius, shortest=shortest, indices=indices, **options)
'''DEPRECATED, use function L{pygeodesy.tienstra7}.'''
def toUtm(latlon, lon=None, datum=None, Utm=_UTM, cmoff=True, name=NN): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.toUtm8}.
@return: The UTM coordinate (B{C{Utm}}) or a 6-tuple C{(zone, easting, northing, band, convergence, scale)} if B{C{Utm}} is C{None} or B{C{cmoff}} is C{False}. ''' U = _MODS.utm.Utm if Utm is _UTM else Utm r = _MODS.utm.toUtm8(latlon, lon=lon, datum=datum, Utm=U, name=name, falsed=cmoff) if isinstance(r, tuple): # UtmUps8Tuple # no hemisphere/pole and datum r = r.zone, r.easting, r.northing, r.band, r.convergence, r.scale return r
def unsign0(x): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.unsigned0}.''' return _MODS.basics.unsigned0(x)
def unStr(name, *args, **kwds): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.unstr}.''' return _MODS.streprs.unstr(name, *args, **kwds)
def utmZoneBand2(lat, lon): # PYCHOK no cover '''DEPRECATED, use function L{pygeodesy.utmZoneBand5}.
@return: 2-Tuple C{(zone, band)}. ''' r = _MODS.utm.utmZoneBand5(lat, lon) # UtmUpsLatLon5Tuple return r.zone, r.band
# **) MIT License # # Copyright (C) 2018-2022 -- mrJean1 at Gmail -- All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the "Software"), # to deal in the Software without restriction, including without limitation # the rights to use, copy, modify, merge, publish, distribute, sublicense, # and/or sell copies of the Software, and to permit persons to whom the # Software is furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR # OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR # OTHER DEALINGS IN THE SOFTWARE. |