Coverage for pygeodesy/deprecated/functions.py: 93%
67 statements
« prev ^ index » next coverage.py v7.2.2, created at 2024-05-15 16:36 -0400
« prev ^ index » next coverage.py v7.2.2, created at 2024-05-15 16:36 -0400
2# -*- coding: utf-8 -*-
4u'''DEPRECATED functions kept for backward compatibility.
5'''
7from pygeodesy.constants import EPS, R_M, float0_
8from pygeodesy.deprecated.classes import ClipCS3Tuple, TriAngle4Tuple, _TriAngle5Tuple
9from pygeodesy.interns import NN, _area_, _COMMASPACE_, _negative_, \
10 _scalar_, _sep_, _SPACE_, _UNDER_, _value_
11from pygeodesy.lazily import _ALL_DEPRECATED, _ALL_MODS as _MODS
12from pygeodesy.props import deprecated_function
13# from pygeodesy.resections import TriAngle5Tuple as _TriAngle5Tuple # from .classes
14from pygeodesy.units import Number_, Scalar_
16__all__ = _ALL_DEPRECATED.deprecated_functions
17__version__ = '24.02.08'
19_WGS84 = _UTM = object()
22@deprecated_function
23def anStr(name, OKd='._-', sub=_UNDER_): # PYCHOK no cover
24 '''DEPRECATED, use function L{pygeodesy.anstr}.'''
25 return _MODS.streprs.anstr(name, OKd=OKd, sub=sub)
28@deprecated_function
29def areaof(points, adjust=True, radius=R_M, wrap=True): # PYCHOK no cover
30 '''DEPRECATED, use function L{pygeodesy.areaOf}.'''
31 return _MODS.points.areaOf(points, adjust=adjust, radius=radius, wrap=wrap)
34@deprecated_function
35def atand(x):
36 '''DEPRECATED on 2023.09.28, use function L{pygeodesy.atan1d}.'''
37 return _MODS.utily.atan1d(x)
40@deprecated_function
41def bounds(points, wrap=True, LatLon=None): # PYCHOK no cover
42 '''DEPRECATED, use function L{pygeodesy.boundsOf}.
44 @return: 2-Tuple C{(latlonSW, latlonNE)} as B{C{LatLon}}
45 or 4-Tuple C{(latS, lonW, latN, lonE)} if
46 B{C{LatLon}} is C{None}.
47 '''
48 return tuple(_MODS.points.boundsOf(points, wrap=wrap, LatLon=LatLon))
51@deprecated_function
52def clipCS3(points, lowerleft, upperright, closed=False, inull=False): # PYCHOK no cover
53 '''DEPRECATED, use function L{pygeodesy.clipCS4}.
55 @return: Yield a L{ClipCS3Tuple}C{(start, end, index)} for each
56 edge of the I{clipped} path.
57 '''
58 for p1, p2, _, j in _MODS.clipy.clipCS4(points, lowerleft, upperright,
59 closed=closed, inull=inull):
60 yield ClipCS3Tuple(p1, p2, j)
63@deprecated_function
64def clipDMS(deg, limit): # PYCHOK no cover
65 '''DEPRECATED, use function L{pygeodesy.clipDegrees}.'''
66 return _MODS.dms.clipDegrees(deg, limit)
69@deprecated_function
70def clipStr(bstr, limit=50, white=NN): # PYCHOK no cover
71 '''DEPRECATED, use function L{pygeodesy.clips}.'''
72 return _MODS.basics.clips(bstr, limit=limit, white=white)
75@deprecated_function
76def collins(pointA, pointB, pointC, alpha, beta, **useZ_Clas_and_kwds):
77 '''DEPRECATED, use function L{pygeodesy.collins5}.'''
78 return _MODS.resections.collins5(pointA, pointB, pointC, alpha, beta,
79 **useZ_Clas_and_kwds)
82@deprecated_function
83def copysign(x, y): # PYCHOK no cover
84 '''DEPRECATED, use function L{pygeodesy.copysign0}.'''
85 return _MODS.basics.copysign0(x, y)
88@deprecated_function
89def decodeEPSG2(arg): # PYCHOK no cover
90 '''DEPRECATED, use function L{epsg.decode2}.
92 @return: 2-Tuple C{(zone, hemipole)}
93 '''
94 return tuple(_MODS.epsg.decode2(arg))
97@deprecated_function
98def encodeEPSG(zone, hemipole=NN, band=NN): # PYCHOK no cover
99 '''DEPRECATED, use function L{epsg.encode}.
101 @return: C{EPSG} code (C{int}).
102 '''
103 return int(_MODS.epsg.encode(zone, hemipole=hemipole, band=band))
106@deprecated_function
107def enStr2(easting, northing, prec, *extras): # PYCHOK no cover
108 '''DEPRECATED, use function L{pygeodesy.enstr2}.'''
109 return _MODS.streprs.enstr2(easting, northing, (int(prec) // 2 - 5), *extras)
112@deprecated_function
113def equirectangular3(lat1, lon1, lat2, lon2, **options): # PYCHOK no cover
114 '''DEPRECATED, use function L{pygeodesy.equirectangular_}.
116 @return: 3-Tuple C{(distance2, delta_lat, delta_lon)}.
117 '''
118 return tuple(_MODS.formy.equirectangular_(lat1, lon1, lat2, lon2, **options)[:3])
121@deprecated_function
122def excessAbc(A, b, c):
123 '''DEPRECATED on 2023.04.04, use function L{pygeodesy.excessAbc_}.'''
124 return _MODS.formy.excessAbc_(A, b, c)
127@deprecated_function
128def excessGirard(A, B, C):
129 '''DEPRECATED on 2023.04.04, use function L{pygeodesy.excessGirard_}.'''
130 return _MODS.formy.excessGirard_(A, B, C)
133@deprecated_function
134def excessLHuilier(a, b, c):
135 '''DEPRECATED on 2023.04.04, use function L{pygeodesy.excessLHuilier_}.'''
136 return _MODS.formy.excessLHuilier_(a, b, c)
139@deprecated_function
140def false2f(value, name=_value_, false=True, Error=ValueError): # PYCHOK no cover
141 '''DEPRECATED, use class L{Easting} or L{Northing}.'''
142 return falsed2f(falsed=false, Error=Error, **{name: value})
145@deprecated_function
146def falsed2f(falsed=True, Error=ValueError, **name_value): # PYCHOK no cover
147 '''DEPRECATED, use class L{Easting} or L{Northing}.
149 Convert a falsed east-/northing to non-negative C{float}.
151 @kwarg falsed: Value includes false origin (C{bool}).
152 @kwarg Error: Optional, overriding error (C{Exception}).
153 @kwarg name_value: One C{B{name}=value} pair.
155 @return: The value (C{float}).
157 @raise Error: Invalid or negative C{B{name}=value}.
158 '''
159 t = NN
160 if len(name_value) == 1:
161 try:
162 for f in name_value.values():
163 f = float(f)
164 if falsed and f < 0:
165 break
166 return f
167 t = _COMMASPACE_('falsed', _negative_)
168 except (TypeError, ValueError) as x:
169 t = str(x)
170 raise _MODS.errors._InvalidError(Error=Error, txt=t, **name_value)
173@deprecated_function
174def float0(*xs):
175 '''DEPRECATED on 2023.04.21, use function L{pygeodesy.float0_}.'''
176 return float0_(*xs)
179@deprecated_function
180def fStr(floats, prec=6, fmt=_MODS.streprs.Fmt.f, ints=False, sep=_COMMASPACE_): # PYCHOK no cover
181 '''DEPRECATED, use function L{fstr}.'''
182 return _MODS.streprs.fstr(floats, prec=prec, fmt=fmt, ints=ints, sep=sep)
185@deprecated_function
186def fStrzs(floatstr): # PYCHOK no cover
187 '''DEPRECATED, use function L{pygeodesy.fstrzs}.'''
188 return _MODS.streprs.fstrzs(floatstr)
191@deprecated_function
192def hypot3(x, y, z): # PYCHOK no cover
193 '''DEPRECATED, use function L{pygeodesy.hypot_}.'''
194 return _MODS.fmath.hypot_(x, y, z)
197@deprecated_function
198def inStr(inst, *args, **kwds): # PYCHOK no cover
199 '''DEPRECATED, use function L{pygeodesy.instr}.'''
200 return _MODS.streprs.instr(inst, *args, **kwds)
203@deprecated_function
204def isenclosedby(point, points, wrap=False): # PYCHOK no cover
205 '''DEPRECATED, use function L{pygeodesy.isenclosedBy}.'''
206 return _MODS.points.isenclosedBy(point, points, wrap=wrap)
209@deprecated_function
210def istuplist(obj, minum=0): # PYCHOK no cover
211 '''DEPRECATED on 2023.03.31, use function L{pygeodesy.islistuple}.'''
212 return _MODS.basics.islistuple(obj, minum=minum)
215@deprecated_function
216def joined(*words, **sep): # PYCHOK no cover
217 '''DEPRECATED, use C{NN(...)}, C{NN.join_} or C{B{sep}.join}.'''
218 return sep.get(_sep_, NN).join(map(str, words))
221@deprecated_function
222def joined_(*words, **sep): # PYCHOK no cover
223 '''DEPRECATED, use C{_SPACE_(...)}, C{_SPACE_.join_} or C{B{sep}.join}, sep=" ".'''
224 return sep.get(_sep_, _SPACE_).join(map(str, words))
227@deprecated_function
228def nearestOn3(point, points, closed=False, wrap=False, **options): # PYCHOK no cover
229 '''DEPRECATED, use function L{pygeodesy.nearestOn5}.
231 @return: 3-Tuple C{(lat, lon, distance)}
232 '''
233 return tuple(_MODS.points.nearestOn5(point, points, closed=closed, wrap=wrap, **options)[:3])
236@deprecated_function
237def nearestOn4(point, points, closed=False, wrap=False, **options): # PYCHOK no cover
238 '''DEPRECATED, use function L{pygeodesy.nearestOn5}.
240 @return: 4-Tuple C{(lat, lon, distance, angle)}
241 '''
242 return tuple(_MODS.points.nearestOn5(point, points, closed=closed, wrap=wrap, **options)[:4])
245@deprecated_function
246def parseUTM(strUTM, datum=_WGS84, Utm=_UTM, name=NN): # PYCHOK no cover
247 '''DEPRECATED, use function L{parseUTM5}.
249 @return: The UTM coordinate (B{L{Utm}}) or 4-tuple C{(zone,
250 hemisphere, easting, northing)} if B{C{Utm}} is C{None}.
251 '''
252 d = _MODS.datums.Datums.WGS84 if datum is _WGS84 else datum # PYCHOK shadows?
253 U = _MODS.utm.Utm if Utm is _UTM else Utm
254 r = _MODS.utm.parseUTM5(strUTM, datum=d, Utm=U, name=name)
255 if isinstance(r, tuple): # UtmUps5Tuple
256 r = r.zone, r.hemipole, r.easting, r.northing # no band
257 return r
260@deprecated_function
261def perimeterof(points, closed=False, adjust=True, radius=R_M, wrap=True): # PYCHOK no cover
262 '''DEPRECATED, use function L{pygeodesy.perimeterOf}.'''
263 return _MODS.points.perimeterOf(points, closed=closed, adjust=adjust, radius=radius, wrap=wrap)
266@deprecated_function
267def polygon(points, closed=True, base=None): # PYCHOK no cover
268 '''DEPRECATED, use function L{pygeodesy.points2}.'''
269 return _MODS.deprecated.bases.points2(points, closed=closed, base=base)
272@deprecated_function
273def scalar(value, low=EPS, high=1.0, name=_scalar_, Error=ValueError): # PYCHOK no cover
274 '''DEPRECATED, use class L{Number_} or L{Scalar_}.
276 @return: New value (C{float} or C{int} for C{int} B{C{low}}).
278 @raise Error: Invalid B{C{value}}.
279 '''
280 C_ = Number_ if _MODS.basics.isint(low) else Scalar_
281 return C_(value, name=name, Error=Error, low=low, high=high)
284@deprecated_function
285def simplify2(points, pipe, radius=R_M, shortest=False, indices=False, **options): # PYCHOK no cover
286 '''DEPRECATED, use function L{pygeodesy.simplifyRW}.
287 '''
288 return _MODS.simplify.simplifyRW(points, pipe, radius=radius, shortest=shortest,
289 indices=indices, **options)
292@deprecated_function
293def tienstra(pointA, pointB, pointC, alpha, **beta_gamma_useZ_Clas_and_kwds):
294 '''DEPRECATED, use function L{pygeodesy.tienstra7}.'''
295 return _MODS.resections.tienstra7(pointA, pointB, pointC, alpha, **beta_gamma_useZ_Clas_and_kwds)
298@deprecated_function
299def toUtm(latlon, lon=None, datum=None, Utm=_UTM, cmoff=True, name=NN): # PYCHOK no cover
300 '''DEPRECATED, use function L{pygeodesy.toUtm8}.
302 @return: The UTM coordinate (B{C{Utm}}) or a 6-tuple C{(zone,
303 easting, northing, band, convergence, scale)} if
304 B{C{Utm}} is C{None} or B{C{cmoff}} is C{False}.
305 '''
306 U = _MODS.utm.Utm if Utm is _UTM else Utm
307 r = _MODS.utm.toUtm8(latlon, lon=lon, datum=datum, Utm=U, name=name, falsed=cmoff)
308 if isinstance(r, tuple): # UtmUps8Tuple
309 # no hemisphere/pole and datum
310 r = r.zone, r.easting, r.northing, r.band, r.gamma, r.scale
311 return r
314# @deprecated_function
315# def trfTransforms(reframe, epoch, reframe2, epoch2):
316# '''DEPRECATED on 2024.02.02, use function L{trfTransform0}C{(reframe, reframe2, epoch=None, epoch2=None)}.
317#
318# @return: A 0-, 1- or 2-tuple of Helmert L{Transform}s or C{None} if no conversion exists.
319# '''
320# t = _MODS.trf.trfTransform0(reframe, reframe2, epoch=epoch, epoch2=epoch2)
321# return (t,) if t else t
324@deprecated_function
325def triAngle4(a, b, c):
326 '''DEPRECATED on 2023.09.14, use function L{pygeodesy.triAngle5}.
328 @return: A I{DEPRECATED} L{TriAngle4Tuple}C{(radA, radB, radC, rIn)}.
329 '''
330 assert _TriAngle5Tuple._Names_.index(_area_) == 4
331 return TriAngle4Tuple(_MODS.resections.triAngle5(a, b, c)[:4])
334@deprecated_function
335def unsign0(x): # PYCHOK no cover
336 '''DEPRECATED, use function L{pygeodesy.unsigned0}.'''
337 return _MODS.basics.unsigned0(x)
340@deprecated_function
341def unStr(name, *args, **kwds): # PYCHOK no cover
342 '''DEPRECATED, use function L{pygeodesy.unstr}.'''
343 return _MODS.streprs.unstr(name, *args, **kwds)
346@deprecated_function
347def utmZoneBand2(lat, lon): # PYCHOK no cover
348 '''DEPRECATED, use function L{pygeodesy.utmZoneBand5}.
350 @return: 2-Tuple C{(zone, band)}.
351 '''
352 r = _MODS.utm.utmZoneBand5(lat, lon) # UtmUpsLatLon5Tuple
353 return r.zone, r.band
355# **) MIT License
356#
357# Copyright (C) 2018-2024 -- mrJean1 at Gmail -- All Rights Reserved.
358#
359# Permission is hereby granted, free of charge, to any person obtaining a
360# copy of this software and associated documentation files (the "Software"),
361# to deal in the Software without restriction, including without limitation
362# the rights to use, copy, modify, merge, publish, distribute, sublicense,
363# and/or sell copies of the Software, and to permit persons to whom the
364# Software is furnished to do so, subject to the following conditions:
365#
366# The above copyright notice and this permission notice shall be included
367# in all copies or substantial portions of the Software.
368#
369# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
370# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
371# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
372# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
373# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
374# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
375# OTHER DEALINGS IN THE SOFTWARE.