1

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

3

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

5'''

6

7 from pygeodesy.constants import EPS, R_M, float0_

8 from pygeodesy.deprecated.classes import ClipCS3Tuple, TriAngle4Tuple, _TriAngle5Tuple

9 from pygeodesy.interns import NN, _area_, _COMMASPACE_, _negative_, \

10 _scalar_, _sep_, _SPACE_, _UNDER_, _value_

11 from pygeodesy.lazily import _ALL_DEPRECATED, _ALL_MODS as _MODS

12 from pygeodesy.props import deprecated_function

13# from pygeodesy.resections import TriAngle5Tuple as _TriAngle5Tuple # from .classes

14 from pygeodesy.units import Number_, Scalar_

15

16__all__ = _ALL_DEPRECATED.deprecated_functions

17__version__ = '24.06.11'

18

19_WGS84 = _UTM = object()

20

21

22@deprecated_function

23 def 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

29 def 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

35 def atand(x):

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

37 return _MODS.utily.atan1d(x)

38

39

40@deprecated_function

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

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

43

44 @return: 2-Tuple C{(latlonSW, latlonNE)}, each a B{C{LatLon}} or

45 4-Tuple C{(latS, lonW, latN, lonE)} if C{B{LatLon} is None}.

46 '''

47 return tuple(_MODS.points.boundsOf(points, wrap=wrap, LatLon=LatLon))

48

49

50@deprecated_function

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

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

53

54 @return: Yield a L{ClipCS3Tuple}C{(start, end, index)} for each

55 edge of the I{clipped} path.

56 '''

57 for p1, p2, _, j in _MODS.clipy.clipCS4(points, lowerleft, upperright,

58 closed=closed, inull=inull):

59 yield ClipCS3Tuple(p1, p2, j)

60

61

62@deprecated_function

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

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

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

66

67

68@deprecated_function

69 def clipStr(bstr, limit=50, white=NN): # PYCHOK no cover

70 '''DEPRECATED, use function L{pygeodesy.clips}.'''

71 return _MODS.basics.clips(bstr, limit=limit, white=white)

72

73

74@deprecated_function

75 def collins(pointA, pointB, pointC, alpha, beta, **useZ_Clas_and_kwds):

76 '''DEPRECATED, use function L{pygeodesy.collins5}.'''

77 return _MODS.resections.collins5(pointA, pointB, pointC, alpha, beta,

78 **useZ_Clas_and_kwds)

79

80

81@deprecated_function

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

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

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

85

86

87@deprecated_function

88 def decodeEPSG2(arg): # PYCHOK no cover

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

90

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

92 '''

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

94

95

96@deprecated_function

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

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

99

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

101 '''

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

103

104

105@deprecated_function

106 def enStr2(easting, northing, prec, *extras): # PYCHOK no cover

107 '''DEPRECATED, use function L{pygeodesy.enstr2}.'''

108 return _MODS.streprs.enstr2(easting, northing, (int(prec) // 2 - 5), *extras)

109

110

111@deprecated_function

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

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

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

115

116

117@deprecated_function

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

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

120

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

122 '''

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

124

125

126@deprecated_function

127 def excessAbc(A, b, c):

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

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

130

131

132@deprecated_function

133 def excessGirard(A, B, C):

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

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

136

137

138@deprecated_function

139 def excessLHuilier(a, b, c):

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

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

142

143

144@deprecated_function

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

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

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

148

149

150@deprecated_function

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

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

153

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

155

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

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

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

159

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

161

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

163 '''

164 t = NN

165 if len(name_value) == 1:

166 try:

167 for f in name_value.values():

168 f = float(f)

169 if falsed and f < 0:

170 break

171 return f

172 t = _COMMASPACE_('falsed', _negative_)

173 except (TypeError, ValueError) as x:

174 t = str(x)

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

176

177

178@deprecated_function

179 def float0(*xs):

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

181 return float0_(*xs)

182

183

184@deprecated_function

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

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

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

188

189

190@deprecated_function

191 def fStrzs(floatstr): # PYCHOK no cover

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

193 return _MODS.streprs.fstrzs(floatstr)

194

195

196@deprecated_function

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

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

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

200

201

202@deprecated_function

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

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

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

206

207

208@deprecated_function

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

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

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

212

213

214@deprecated_function

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

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

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

218

219

220@deprecated_function

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

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

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

224

225

226@deprecated_function

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

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

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

230

231

232@deprecated_function

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

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

235

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

237 '''

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

239

240

241@deprecated_function

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

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

244

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

246 '''

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

248

249

250@deprecated_function

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

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

253

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

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

256 '''

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

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

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

260 if isinstance(r, tuple): # UtmUps5Tuple

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

262 return r

263

264

265@deprecated_function

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

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

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

269

270

271@deprecated_function

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

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

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

275

276

277@deprecated_function

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

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

280

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

282

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

284 '''

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

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

287

288

289@deprecated_function

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

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

292 '''

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

294 indices=indices, **options)

295

296

297@deprecated_function

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

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

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

301

302

303@deprecated_function

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

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

306

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

308 band, convergence, scale)} if C{B{Utm} is None} or C{B{cmoff} is False}.

309 '''

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

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

312 if isinstance(r, tuple): # UtmUps8Tuple

313 # no hemisphere/pole and datum

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

315 return r

316

317

318# @deprecated_function

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

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

321#

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

323# '''

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

325# return (t,) if t else t

326

327

328@deprecated_function

329 def triAngle4(a, b, c):

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

331

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

333 '''

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

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

336

337

338@deprecated_function

339 def unsign0(x): # PYCHOK no cover

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

341 return _MODS.basics.unsigned0(x)

342

343

344@deprecated_function

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

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

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

348

349

350@deprecated_function

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

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

353

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

355 '''

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

357 return r.zone, r.band

358

359# **) MIT License

360#

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

362#

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

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

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

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

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

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

369#

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

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

372#

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

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

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

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

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

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

379# OTHER DEALINGS IN THE SOFTWARE.