Hide keyboard shortcuts

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

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

 

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

 

u'''DEPRECATED classes, functions, methods, etc. 

 

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}. 

''' 

from pygeodesy.ecef import Ecef9Tuple as _Ecef9Tuple 

from pygeodesy.errors import TRFError as _TRFError 

from pygeodesy.heights import HeightIDWequirectangular as _HeightIDWequirectangular, \ 

HeightIDWeuclidean as _HeightIDWeuclidean, \ 

HeightIDWhaversine as _HeightIDWhaversine 

from pygeodesy.interns import EPS, NN, R_M, _COMMASPACE_, _scalar_, _SPACE_, _UNDER_ 

from pygeodesy.interns import _easting_, _end_, _hemipole_, _northing_, _sep_, \ 

_start_, _zone_ # PYCHOK used! 

from pygeodesy.lazily import _ALL_LAZY, isLazy 

from pygeodesy.ltp import LocalCartesian 

from pygeodesy.props import deprecated_class, deprecated_function, deprecated_method 

from pygeodesy.named import _NamedTuple, _Pass 

from pygeodesy.streprs import Fmt as _Fmt 

from pygeodesy.units import Easting, Northing, Number_, Scalar_, Str 

if isLazy: # XXX force import of all deprecated modules 

import pygeodesy.deprecated.bases as bases, \ 

pygeodesy.deprecated.datum as datum, \ 

pygeodesy.deprecated.nvector as nvector # PYCHOK unused 

# XXX instead, use module_property or enhance .lazily 

 

__all__ = _ALL_LAZY.deprecated 

__version__ = '21.10.05' 

 

OK = 'OK' # OK for test like I{if ... is OK: ...} 

_value_ = 'value' 

_WGS84 = _UTM = object() 

 

 

# DEPRECATED classes, for export only 

class ClipCS3Tuple(_NamedTuple): # PYCHOK no cover 

'''3-Tuple C{(start, end, index)}. DEPRECATED, see function L{pygeodesy.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) 

 

 

class EcefCartesian(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. 

''' 

def __init__(self, latlonh0=0, lon0=0, height0=0, ecef=None, name=NN): 

deprecated_class(self.__class__) 

LocalCartesian.__init__(self, latlonh0=latlonh0, lon0=lon0, height0=height0, ecef=ecef, name=name) 

 

@deprecated_method 

def forward(self, latlonh, lon=None, height=0, M=False, name=NN): 

'''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}. 

''' 

t = LocalCartesian.forward(self, latlonh, lon=lon, height=height, M=M, name=name) 

return _Ecef9Tuple(t.x, t.y, t.z, t.lat, t.lon, t.height, 

0, t.M, t.ecef.datum, 

name=t.name or self.name) 

 

@deprecated_method 

def reverse(self, xyz, y=None, z=None, M=False, name=NN): 

'''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 = LocalCartesian.reverse(self, xyz, y=y, z=z, M=M, name=name) 

return _Ecef9Tuple(t.x, t.y, t.z, t.lat, t.lon, t.height, 

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) 

 

 

@deprecated_function 

def anStr(name, OKd='._-', sub=_UNDER_): # PYCHOK no cover 

'''DEPRECATED, use function L{pygeodesy.anstr}. 

''' 

from pygeodesy.streprs import anstr 

return anstr(name, OKd=OKd, sub=sub) 

 

 

@deprecated_function 

def areaof(points, adjust=True, radius=R_M, wrap=True): # PYCHOK no cover 

'''DEPRECATED, use function L{pygeodesy.areaOf}. 

''' 

from pygeodesy.points import areaOf 

return areaOf(points, adjust=adjust, radius=radius, wrap=wrap) 

 

 

@deprecated_function 

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}. 

''' 

from pygeodesy.points import boundsOf 

return tuple(boundsOf(points, wrap=wrap, LatLon=LatLon)) 

 

 

@deprecated_function 

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. 

''' 

from pygeodesy.clipy import clipCS4 

for p1, p2, _, j in clipCS4(points, lowerleft, upperright, 

closed=closed, inull=inull): 

yield ClipCS3Tuple(p1, p2, j) 

 

 

@deprecated_function 

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

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

''' 

from pygeodesy.dms import clipDegrees 

return clipDegrees(deg, limit) 

 

 

@deprecated_function 

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

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

''' 

from pygeodesy.basics import clips 

return clips(bstr, limit=limit, white=white) 

 

 

@deprecated_function 

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

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

''' 

from pygeodesy.basics import copysign0 

return copysign0(x, y) 

 

 

@deprecated_function 

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

 

 

@deprecated_function 

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

 

 

@deprecated_function 

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

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

''' 

from pygeodesy.streprs import enstr2 

return enstr2(easting, northing, prec, *extras) 

 

 

@deprecated_function 

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

 

 

@deprecated_function 

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

 

 

@deprecated_function 

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) 

 

 

@deprecated_function 

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) 

 

 

@deprecated_function 

def fStrzs(floatstr): # PYCHOK no cover 

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

''' 

from pygeodesy.streprs import fstrzs 

return fstrzs(floatstr) 

 

 

@deprecated_function 

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

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

''' 

from pygeodesy.fmath import hypot_ 

return hypot_(x, y, z) 

 

 

@deprecated_function 

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

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

''' 

from pygeodesy.streprs import instr 

return instr(inst, *args, **kwds) 

 

 

@deprecated_function 

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

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

''' 

from pygeodesy.points import isenclosedBy 

return isenclosedBy(point, points, wrap=wrap) 

 

 

@deprecated_function 

def joined(*words, **sep): # sep=NN 

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

''' 

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

 

 

@deprecated_function 

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

 

 

@deprecated_function 

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

''' 

from pygeodesy.points import nearestOn5 # no name conflict 

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

 

 

@deprecated_function 

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

''' 

from pygeodesy.points import nearestOn5 # no name conflict 

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

 

 

@deprecated_function 

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 

 

 

@deprecated_function 

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) 

 

 

@deprecated_function 

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) 

 

 

@deprecated_function 

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) 

 

 

@deprecated_function 

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

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

''' 

from pygeodesy.simplify import simplifyRW 

return simplifyRW(points, pipe, radius=radius, shortest=shortest, indices=indices, **options) 

 

 

@deprecated_function 

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}. 

''' 

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 

 

 

@deprecated_function 

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

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

''' 

from pygeodesy.streprs import unstr 

return unstr(name, *args, **kwds) 

 

 

@deprecated_function 

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

'''DEPRECATED, use function L{pygeodesy.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.