Coverage for pygeodesy/deprecated/functions.py: 93%

68 statements  

« prev     ^ index     » next       coverage.py v7.2.2, created at 2024-06-01 11:43 -0400

1 

2# -*- coding: utf-8 -*- 

3 

4u'''DEPRECATED functions kept for backward compatibility. 

5''' 

6 

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_ 

15 

16__all__ = _ALL_DEPRECATED.deprecated_functions 

17__version__ = '24.05.25' 

18 

19_WGS84 = _UTM = object() 

20 

21 

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) 

26 

27 

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) 

32 

33 

34@deprecated_function 

35def atand(x): 

36 '''DEPRECATED on 2023.09.28, use function L{pygeodesy.atan1d}.''' 

37 return _MODS.utily.atan1d(x) 

38 

39 

40@deprecated_function 

41def bounds(points, wrap=True, LatLon=None): # PYCHOK no cover 

42 '''DEPRECATED, use function L{pygeodesy.boundsOf}. 

43 

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)) 

49 

50 

51@deprecated_function 

52def clipCS3(points, lowerleft, upperright, closed=False, inull=False): # PYCHOK no cover 

53 '''DEPRECATED, use function L{pygeodesy.clipCS4}. 

54 

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) 

61 

62 

63@deprecated_function 

64def clipDMS(deg, limit): # PYCHOK no cover 

65 '''DEPRECATED, use function L{pygeodesy.clipDegrees}.''' 

66 return _MODS.dms.clipDegrees(deg, limit) 

67 

68 

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) 

73 

74 

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) 

80 

81 

82@deprecated_function 

83def copysign(x, y): # PYCHOK no cover 

84 '''DEPRECATED, use function L{pygeodesy.copysign0}.''' 

85 return _MODS.basics.copysign0(x, y) 

86 

87 

88@deprecated_function 

89def decodeEPSG2(arg): # PYCHOK no cover 

90 '''DEPRECATED, use function L{epsg.decode2}. 

91 

92 @return: 2-Tuple C{(zone, hemipole)} 

93 ''' 

94 return tuple(_MODS.epsg.decode2(arg)) 

95 

96 

97@deprecated_function 

98def encodeEPSG(zone, hemipole=NN, band=NN): # PYCHOK no cover 

99 '''DEPRECATED, use function L{epsg.encode}. 

100 

101 @return: C{EPSG} code (C{int}). 

102 ''' 

103 return int(_MODS.epsg.encode(zone, hemipole=hemipole, band=band)) 

104 

105 

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) 

110 

111 

112@deprecated_function 

113def equirectangular_(lat1, lon1, lat2, lon2, **options): # PYCHOK no cover 

114 '''DEPRECATED on 2024.05.25, use function L{pygeodesy.equirectangular4}.''' 

115 return _MODS.formy.equirectangular4(lat1, lon1, lat2, lon2, **options) 

116 

117 

118@deprecated_function 

119def equirectangular3(lat1, lon1, lat2, lon2, **options): # PYCHOK no cover 

120 '''DEPRECATED, use function L{pygeodesy.equirectangular4}. 

121 

122 @return: 3-Tuple C{(distance2, delta_lat, delta_lon)}. 

123 ''' 

124 return tuple(_MODS.formy.equirectangular4(lat1, lon1, lat2, lon2, **options)[:3]) 

125 

126 

127@deprecated_function 

128def excessAbc(A, b, c): 

129 '''DEPRECATED on 2023.04.04, use function L{pygeodesy.excessAbc_}.''' 

130 return _MODS.formy.excessAbc_(A, b, c) 

131 

132 

133@deprecated_function 

134def excessGirard(A, B, C): 

135 '''DEPRECATED on 2023.04.04, use function L{pygeodesy.excessGirard_}.''' 

136 return _MODS.formy.excessGirard_(A, B, C) 

137 

138 

139@deprecated_function 

140def excessLHuilier(a, b, c): 

141 '''DEPRECATED on 2023.04.04, use function L{pygeodesy.excessLHuilier_}.''' 

142 return _MODS.formy.excessLHuilier_(a, b, c) 

143 

144 

145@deprecated_function 

146def false2f(value, name=_value_, false=True, Error=ValueError): # PYCHOK no cover 

147 '''DEPRECATED, use class L{Easting} or L{Northing}.''' 

148 return falsed2f(falsed=false, Error=Error, **{name: value}) 

149 

150 

151@deprecated_function 

152def falsed2f(falsed=True, Error=ValueError, **name_value): # PYCHOK no cover 

153 '''DEPRECATED, use class L{Easting} or L{Northing}. 

154 

155 Convert a falsed east-/northing to non-negative C{float}. 

156 

157 @kwarg falsed: Value includes false origin (C{bool}). 

158 @kwarg Error: Optional, overriding error (C{Exception}). 

159 @kwarg name_value: One C{B{name}=value} pair. 

160 

161 @return: The value (C{float}). 

162 

163 @raise Error: Invalid or negative C{B{name}=value}. 

164 ''' 

165 t = NN 

166 if len(name_value) == 1: 

167 try: 

168 for f in name_value.values(): 

169 f = float(f) 

170 if falsed and f < 0: 

171 break 

172 return f 

173 t = _COMMASPACE_('falsed', _negative_) 

174 except (TypeError, ValueError) as x: 

175 t = str(x) 

176 raise _MODS.errors._InvalidError(Error=Error, txt=t, **name_value) 

177 

178 

179@deprecated_function 

180def float0(*xs): 

181 '''DEPRECATED on 2023.04.21, use function L{pygeodesy.float0_}.''' 

182 return float0_(*xs) 

183 

184 

185@deprecated_function 

186def fStr(floats, prec=6, fmt=_MODS.streprs.Fmt.f, ints=False, sep=_COMMASPACE_): # PYCHOK no cover 

187 '''DEPRECATED, use function L{fstr}.''' 

188 return _MODS.streprs.fstr(floats, prec=prec, fmt=fmt, ints=ints, sep=sep) 

189 

190 

191@deprecated_function 

192def fStrzs(floatstr): # PYCHOK no cover 

193 '''DEPRECATED, use function L{pygeodesy.fstrzs}.''' 

194 return _MODS.streprs.fstrzs(floatstr) 

195 

196 

197@deprecated_function 

198def hypot3(x, y, z): # PYCHOK no cover 

199 '''DEPRECATED, use function L{pygeodesy.hypot_}.''' 

200 return _MODS.fmath.hypot_(x, y, z) 

201 

202 

203@deprecated_function 

204def inStr(inst, *args, **kwds): # PYCHOK no cover 

205 '''DEPRECATED, use function L{pygeodesy.instr}.''' 

206 return _MODS.streprs.instr(inst, *args, **kwds) 

207 

208 

209@deprecated_function 

210def isenclosedby(point, points, wrap=False): # PYCHOK no cover 

211 '''DEPRECATED, use function L{pygeodesy.isenclosedBy}.''' 

212 return _MODS.points.isenclosedBy(point, points, wrap=wrap) 

213 

214 

215@deprecated_function 

216def istuplist(obj, minum=0): # PYCHOK no cover 

217 '''DEPRECATED on 2023.03.31, use function L{pygeodesy.islistuple}.''' 

218 return _MODS.basics.islistuple(obj, minum=minum) 

219 

220 

221@deprecated_function 

222def joined(*words, **sep): # PYCHOK no cover 

223 '''DEPRECATED, use C{NN(...)}, C{NN.join_} or C{B{sep}.join}.''' 

224 return sep.get(_sep_, NN).join(map(str, words)) 

225 

226 

227@deprecated_function 

228def joined_(*words, **sep): # PYCHOK no cover 

229 '''DEPRECATED, use C{_SPACE_(...)}, C{_SPACE_.join_} or C{B{sep}.join}, sep=" ".''' 

230 return sep.get(_sep_, _SPACE_).join(map(str, words)) 

231 

232 

233@deprecated_function 

234def nearestOn3(point, points, closed=False, wrap=False, **options): # PYCHOK no cover 

235 '''DEPRECATED, use function L{pygeodesy.nearestOn5}. 

236 

237 @return: 3-Tuple C{(lat, lon, distance)} 

238 ''' 

239 return tuple(_MODS.points.nearestOn5(point, points, closed=closed, wrap=wrap, **options)[:3]) 

240 

241 

242@deprecated_function 

243def nearestOn4(point, points, closed=False, wrap=False, **options): # PYCHOK no cover 

244 '''DEPRECATED, use function L{pygeodesy.nearestOn5}. 

245 

246 @return: 4-Tuple C{(lat, lon, distance, angle)} 

247 ''' 

248 return tuple(_MODS.points.nearestOn5(point, points, closed=closed, wrap=wrap, **options)[:4]) 

249 

250 

251@deprecated_function 

252def parseUTM(strUTM, datum=_WGS84, Utm=_UTM, name=NN): # PYCHOK no cover 

253 '''DEPRECATED, use function L{parseUTM5}. 

254 

255 @return: The UTM coordinate (B{L{Utm}}) or 4-tuple C{(zone, 

256 hemisphere, easting, northing)} if B{C{Utm}} is C{None}. 

257 ''' 

258 d = _MODS.datums.Datums.WGS84 if datum is _WGS84 else datum # PYCHOK shadows? 

259 U = _MODS.utm.Utm if Utm is _UTM else Utm 

260 r = _MODS.utm.parseUTM5(strUTM, datum=d, Utm=U, name=name) 

261 if isinstance(r, tuple): # UtmUps5Tuple 

262 r = r.zone, r.hemipole, r.easting, r.northing # no band 

263 return r 

264 

265 

266@deprecated_function 

267def perimeterof(points, closed=False, adjust=True, radius=R_M, wrap=True): # PYCHOK no cover 

268 '''DEPRECATED, use function L{pygeodesy.perimeterOf}.''' 

269 return _MODS.points.perimeterOf(points, closed=closed, adjust=adjust, radius=radius, wrap=wrap) 

270 

271 

272@deprecated_function 

273def polygon(points, closed=True, base=None): # PYCHOK no cover 

274 '''DEPRECATED, use function L{pygeodesy.points2}.''' 

275 return _MODS.deprecated.bases.points2(points, closed=closed, base=base) 

276 

277 

278@deprecated_function 

279def scalar(value, low=EPS, high=1.0, name=_scalar_, Error=ValueError): # PYCHOK no cover 

280 '''DEPRECATED, use class L{Number_} or L{Scalar_}. 

281 

282 @return: New value (C{float} or C{int} for C{int} B{C{low}}). 

283 

284 @raise Error: Invalid B{C{value}}. 

285 ''' 

286 C_ = Number_ if _MODS.basics.isint(low) else Scalar_ 

287 return C_(value, name=name, Error=Error, low=low, high=high) 

288 

289 

290@deprecated_function 

291def simplify2(points, pipe, radius=R_M, shortest=False, indices=False, **options): # PYCHOK no cover 

292 '''DEPRECATED, use function L{pygeodesy.simplifyRW}. 

293 ''' 

294 return _MODS.simplify.simplifyRW(points, pipe, radius=radius, shortest=shortest, 

295 indices=indices, **options) 

296 

297 

298@deprecated_function 

299def tienstra(pointA, pointB, pointC, alpha, **beta_gamma_useZ_Clas_and_kwds): 

300 '''DEPRECATED, use function L{pygeodesy.tienstra7}.''' 

301 return _MODS.resections.tienstra7(pointA, pointB, pointC, alpha, **beta_gamma_useZ_Clas_and_kwds) 

302 

303 

304@deprecated_function 

305def toUtm(latlon, lon=None, datum=None, Utm=_UTM, cmoff=True, name=NN): # PYCHOK no cover 

306 '''DEPRECATED, use function L{pygeodesy.toUtm8}. 

307 

308 @return: The UTM coordinate (B{C{Utm}}) or a 6-tuple C{(zone, 

309 easting, northing, band, convergence, scale)} if 

310 B{C{Utm}} is C{None} or B{C{cmoff}} is C{False}. 

311 ''' 

312 U = _MODS.utm.Utm if Utm is _UTM else Utm 

313 r = _MODS.utm.toUtm8(latlon, lon=lon, datum=datum, Utm=U, name=name, falsed=cmoff) 

314 if isinstance(r, tuple): # UtmUps8Tuple 

315 # no hemisphere/pole and datum 

316 r = r.zone, r.easting, r.northing, r.band, r.gamma, r.scale 

317 return r 

318 

319 

320# @deprecated_function 

321# def trfTransforms(reframe, epoch, reframe2, epoch2): 

322# '''DEPRECATED on 2024.02.02, use function L{trfTransform0}C{(reframe, reframe2, epoch=None, epoch2=None)}. 

323# 

324# @return: A 0-, 1- or 2-tuple of Helmert L{Transform}s or C{None} if no conversion exists. 

325# ''' 

326# t = _MODS.trf.trfTransform0(reframe, reframe2, epoch=epoch, epoch2=epoch2) 

327# return (t,) if t else t 

328 

329 

330@deprecated_function 

331def triAngle4(a, b, c): 

332 '''DEPRECATED on 2023.09.14, use function L{pygeodesy.triAngle5}. 

333 

334 @return: A I{DEPRECATED} L{TriAngle4Tuple}C{(radA, radB, radC, rIn)}. 

335 ''' 

336 assert _TriAngle5Tuple._Names_.index(_area_) == 4 

337 return TriAngle4Tuple(_MODS.resections.triAngle5(a, b, c)[:4]) 

338 

339 

340@deprecated_function 

341def unsign0(x): # PYCHOK no cover 

342 '''DEPRECATED, use function L{pygeodesy.unsigned0}.''' 

343 return _MODS.basics.unsigned0(x) 

344 

345 

346@deprecated_function 

347def unStr(name, *args, **kwds): # PYCHOK no cover 

348 '''DEPRECATED, use function L{pygeodesy.unstr}.''' 

349 return _MODS.streprs.unstr(name, *args, **kwds) 

350 

351 

352@deprecated_function 

353def utmZoneBand2(lat, lon): # PYCHOK no cover 

354 '''DEPRECATED, use function L{pygeodesy.utmZoneBand5}. 

355 

356 @return: 2-Tuple C{(zone, band)}. 

357 ''' 

358 r = _MODS.utm.utmZoneBand5(lat, lon) # UtmUpsLatLon5Tuple 

359 return r.zone, r.band 

360 

361# **) MIT License 

362# 

363# Copyright (C) 2018-2024 -- mrJean1 at Gmail -- All Rights Reserved. 

364# 

365# Permission is hereby granted, free of charge, to any person obtaining a 

366# copy of this software and associated documentation files (the "Software"), 

367# to deal in the Software without restriction, including without limitation 

368# the rights to use, copy, modify, merge, publish, distribute, sublicense, 

369# and/or sell copies of the Software, and to permit persons to whom the 

370# Software is furnished to do so, subject to the following conditions: 

371# 

372# The above copyright notice and this permission notice shall be included 

373# in all copies or substantial portions of the Software. 

374# 

375# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 

376# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 

377# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 

378# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 

379# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 

380# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 

381# OTHER DEALINGS IN THE SOFTWARE.