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}. ''' HeightIDWeuclidean as _HeightIDWeuclidean, \ HeightIDWhaversine as _HeightIDWhaversine _start_, _zone_ # PYCHOK used! pygeodesy.deprecated.datum as datum, \ pygeodesy.deprecated.nvector as nvector # PYCHOK unused # XXX instead, use module_property or enhance .lazily
# DEPRECATED classes, for export only class ClipCS3Tuple(_NamedTuple): # PYCHOK no cover '''3-Tuple C{(start, end, index)}. DEPRECATED, see function L{clipCS3}. ''' _Names_ = (_start_, _end_, 'index') _Units_ = (_Pass, _Pass, Number_)
def __new__(cls, start, end, ndex, name=NN): deprecated_class(cls) return _NamedTuple.__new__(cls, start, end, ndex, name=name)
'''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)
class HeightIDW(_HeightIDWeuclidean): # PYCHOK no cover '''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)
class HeightIDW2(_HeightIDWequirectangular): # PYCHOK no cover '''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)
class HeightIDW3(_HeightIDWhaversine): # PYCHOK no cover '''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)
class RefFrameError(_TRFError): # PYCHOK no cover '''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)
class UtmUps4Tuple(_NamedTuple): # PYCHOK no cover '''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 __new__(cls, zone, hemipole, easting, northing, name=NN): deprecated_class(cls) return _NamedTuple.__new__(cls, zone, hemipole, easting, northing, name=name)
def anStr(name, OKd='._-', sub=_UNDER_): # PYCHOK no cover '''DEPRECATED, use function L{anstr}. ''' from pygeodesy.streprs import anstr return anstr(name, OKd=OKd, sub=sub)
def areaof(points, adjust=True, radius=R_M, wrap=True): # PYCHOK no cover '''DEPRECATED, use function L{areaOf}. ''' from pygeodesy.points import areaOf return areaOf(points, adjust=adjust, radius=radius, wrap=wrap)
def bounds(points, wrap=True, LatLon=None): # PYCHOK no cover '''DEPRECATED, use function L{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}. ''' from pygeodesy.points import boundsOf return tuple(boundsOf(points, wrap=wrap, LatLon=LatLon))
def clipCS3(points, lowerleft, upperright, closed=False, inull=False): # PYCHOK no cover '''DEPRECATED, use function L{clipCS4}.
@return: Yield a L{ClipCS3Tuple}C{(start, end, index)} for each edge of the I{clipped} path. ''' from pygeodesy.clipy import clipCS4 for p1, p2, _, j in clipCS4(points, lowerleft, upperright, closed=closed, inull=inull): yield ClipCS3Tuple(p1, p2, j)
def clipDMS(deg, limit): # PYCHOK no cover '''DEPRECATED, use function L{clipDegrees}. ''' from pygeodesy.dms import clipDegrees return clipDegrees(deg, limit)
def clipStr(bstr, limit=50, white=NN): # PYCHOK no cover '''DEPRECATED, use function L{clips}. ''' from pygeodesy.basics import clips return clips(bstr, limit=limit, white=white)
def copysign(x, y): # PYCHOK no cover '''DEPRECATED, use function L{copysign0}. ''' from pygeodesy.basics import copysign0 return copysign0(x, y)
def decodeEPSG2(arg): # PYCHOK no cover '''DEPRECATED, use function L{epsg.decode2}.
@return: 2-Tuple C{(zone, hemipole)} ''' from pygeodesy.epsg import decode2 return tuple(decode2(arg))
def encodeEPSG(zone, hemipole=NN, band=NN): # PYCHOK no cover '''DEPRECATED, use function L{epsg.encode}.
@return: C{EPSG} code (C{int}). ''' from pygeodesy.epsg import encode return int(encode(zone, hemipole=hemipole, band=band))
def enStr2(easting, northing, prec, *extras): # PYCHOK no cover '''DEPRECATED, use function L{enstr2}. ''' from pygeodesy.streprs import enstr2 return enstr2(easting, northing, prec, *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)}. ''' from pygeodesy.formy import equirectangular_ return tuple(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 = 'falsed, negative' except (TypeError, ValueError) as x: t = str(x) from pygeodesy.errors import _InvalidError raise _InvalidError(Error=Error, txt=t, **name_value)
def fStr(floats, prec=6, fmt=_Fmt.f, ints=False, sep=_COMMASPACE_): # PYCHOK no cover '''DEPRECATED, use function L{fstr}. ''' from pygeodesy.streprs import fstr return fstr(floats, prec=prec, fmt=fmt, ints=ints, sep=sep)
def fStrzs(floatstr): # PYCHOK no cover '''DEPRECATED, use function L{fstrzs}. ''' from pygeodesy.streprs import fstrzs return fstrzs(floatstr)
def hypot3(x, y, z): # PYCHOK no cover '''DEPRECATED, use function L{hypot_}. ''' from pygeodesy.fmath import hypot_ return hypot_(x, y, z)
def inStr(inst, *args, **kwds): # PYCHOK no cover '''DEPRECATED, use function L{instr}. ''' from pygeodesy.streprs import instr return instr(inst, *args, **kwds)
def isenclosedby(point, points, wrap=False): # PYCHOK no cover '''DEPRECATED, use function L{isenclosedBy}. ''' from pygeodesy.points import isenclosedBy return isenclosedBy(point, points, wrap=wrap)
'''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{nearestOn5}.
@return: 3-Tuple C{(lat, lon, distance)} ''' from pygeodesy.points import nearestOn5 # no name conflict return tuple(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{nearestOn5}.
@return: 4-Tuple C{(lat, lon, distance, angle)} ''' from pygeodesy.points import nearestOn5 # no name conflict return tuple(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}. ''' from pygeodesy.datums import Datums # PYCHOK shadows? from pygeodesy.utm import parseUTM5, Utm as _Utm d = Datums.WGS84 if datum is _WGS84 else datum # PYCHOK shadows? U = _Utm if Utm is _UTM else Utm r = 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}. ''' from pygeodesy.points import perimeterOf return 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}}. ''' from pygeodesy.basics import isint C_ = Number_ if 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{simplifyRW}. ''' from pygeodesy.simplify import simplifyRW return simplifyRW(points, pipe, radius=radius, shortest=shortest, indices=indices, **options)
def toUtm(latlon, lon=None, datum=None, Utm=_UTM, cmoff=True, name=NN): # PYCHOK no cover '''DEPRECATED, use function L{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}. ''' from pygeodesy.utm import toUtm8, Utm as _Utm U = _Utm if Utm is _UTM else Utm r = 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 unStr(name, *args, **kwds): # PYCHOK no cover '''DEPRECATED, use function L{unstr}. ''' from pygeodesy.streprs import unstr return unstr(name, *args, **kwds)
def utmZoneBand2(lat, lon): # PYCHOK no cover '''DEPRECATED, use function L{utmZoneBand5}.
@return: 2-Tuple C{(zone, band)}. ''' from pygeodesy.utm import utmZoneBand5 r = utmZoneBand5(lat, lon) # UtmUpsLatLon5Tuple return r.zone, r.band
# **) MIT License # # Copyright (C) 2018-2021 -- 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. |