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

 

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

 

u'''(INTERNAL) Base class C{UtmUpsBase} and private functions 

for the UTM, UPS, Mgrs and Epsg classes/modules. 

''' 

 

from pygeodesy.ellipsoidalBase import LatLonEllipsoidalBase as _LLEB 

from pygeodesy.datum import Datums 

from pygeodesy.dms import degDMS, parseDMS2 

from pygeodesy.fmath import fStr, isscalar, _IsNotError 

from pygeodesy.lazily import _ALL_DOCS 

from pygeodesy.named import EasNor2Tuple, LatLonDatum5Tuple, \ 

_NamedBase, nameof, _xattrs, _xnamed 

from pygeodesy.utily import issubclassof, property_RO, _Strs, \ 

_TypeError, wrap90, wrap360 

 

__all__ = _ALL_DOCS('UtmUpsBase') 

__version__ = '20.01.22' 

 

_MGRS_TILE = 100e3 # PYCHOK block size (C{meter}) 

 

_UTM_LAT_MAX = 84 # PYCHOK for export (C{degrees}) 

_UTM_LAT_MIN = -80 # PYCHOK for export (C{degrees}) 

_UTM_ZONE_MAX = 60 # PYCHOK for export 

_UTM_ZONE_MIN = 1 # PYCHOK for export 

_UTM_ZONE_OFF_MAX = 60 # PYCHOK max Central meridian offset (C{degrees}) 

 

_UPS_LAT_MAX = _UTM_LAT_MAX - 0.5 # PYCHOK includes 30' UTM overlap 

_UPS_LAT_MIN = _UTM_LAT_MIN + 0.5 # PYCHOK includes 30' UTM overlap 

_UPS_ZONE = _UTM_ZONE_MIN - 1 # PYCHOK for export 

_UPS_ZONE_STR = '%02d' % (_UPS_ZONE,) # PYCHOK for export 

 

_UTMUPS_ZONE_INVALID = -4 # PYCHOK for export too 

_UTMUPS_ZONE_MIN = _UPS_ZONE # PYCHOK for export too 

_UTMUPS_ZONE_MAX = _UTM_ZONE_MAX # PYCHOK for export too 

 

# _MAX_PSEUDO_ZONE = -1 

# _MIN_PSEUDO_ZONE = -4 

# _UTMUPS_ZONE_MATCH = -3 

# _UTMUPS_ZONE_STANDARD = -1 

# _UTM = -2 

 

 

def _hemi(lat): # imported by .ups, .utm 

'''Return the hemisphere letter. 

 

@param lat: Latitude (C{degrees} or C{radians}). 

 

@return: C{'N'|'S'} for north-/southern hemisphere. 

''' 

return 'S' if lat < 0 else 'N' 

 

 

def _to4lldn(latlon, lon, datum, name): 

'''(INTERNAL) Return 4-tuple (C{lat, lon, datum, name}). 

''' 

try: 

# if lon is not None: 

# raise AttributeError 

lat, lon = latlon.lat, latlon.lon 

_TypeError(_LLEB, LatLonDatum5Tuple, latlon=latlon) 

d = datum or latlon.datum 

except AttributeError: 

lat, lon = parseDMS2(latlon, lon) 

d = datum or Datums.WGS84 

return lat, lon, d, (name or nameof(latlon)) 

 

 

def _to3zBhp(zone, band, hemipole=''): # imported by .epsg, .ups, .utm, .utmups 

'''Parse UTM/UPS zone, Band letter and hemisphere/pole letter. 

 

@param zone: Zone with/-out Band (C{scalar} or C{str}). 

@keyword band: Optional (longitudinal/polar) Band letter (C{str}). 

@keyword hemipole: Optional hemisphere/pole letter (C{str}). 

 

@return: 3-Tuple (C{zone, Band, hemisphere/pole}) as (C{int, 

str, 'N'|'S'}) where C{zone} is C{0} for UPS or 

C{1..60} for UTM and C{Band} is C{'A'..'Z'} I{NOT} 

checked for valid UTM/UPS bands. 

 

@raise ValueError: Invalid B{C{zone}}, B{C{band}} or B{C{hemipole}}. 

''' 

B = band 

try: 

z = _UTMUPS_ZONE_INVALID 

if isscalar(zone) or zone.isdigit(): 

z = int(zone) 

elif zone and isinstance(zone, _Strs): 

if len(zone) > 1: 

B = zone[-1:] 

z = int(zone[:-1]) 

elif zone in 'AaBbYyZz': # single letter 

B = zone 

z = _UPS_ZONE 

 

if _UTMUPS_ZONE_MIN <= z <= _UTMUPS_ZONE_MAX: 

hp = hemipole[:1].upper() 

if hp in ('N', 'S') or not hp: 

B = B.upper() 

if B.isalpha(): 

return z, B, (hp or ('S' if B < 'N' else 'N')) 

elif not B: 

return z, B, hp 

 

except (AttributeError, TypeError, ValueError): 

pass 

raise ValueError('%s, %s or %s invalid: %r' % 

('zone', 'band', 'hemipole', (zone, B, hemipole))) 

 

 

def _to3zll(lat, lon): # imported by .ups, .utm 

'''Wrap lat- and longitude and determine UTM zone. 

 

@param lat: Latitude (C{degrees}). 

@param lon: Longitude (C{degrees}). 

 

@return: 3-Tuple (C{zone, lat, lon}) as (C{int}, C{degrees90}, 

C{degrees180}) where C{zone} is C{1..60} for UTM. 

''' 

x = wrap360(lon + 180) # use wrap360 to get ... 

z = int(x) // 6 + 1 # ... longitudinal UTM zone [1, 60] and ... 

lon = x - 180 # ... lon [-180, 180) i.e. -180 <= lon < 180 

return z, wrap90(lat), lon 

 

 

class UtmUpsBase(_NamedBase): 

'''Base class for L{Utm} and L{Ups} coordinates. 

''' 

_band = '' #: (INTERNAL) Latitude band letter ('A..Z'). 

_convergence = None #: (INTERNAL) Meridian conversion (C{degrees}). 

_datum = Datums.WGS84 #: (INTERNAL) L{Datum}. 

_easting = 0 #: (INTERNAL) Easting, see B{C{falsed}} (C{meter}). 

_epsg = None #: (INTERNAL) toEpsg cache (L{Epsg}). 

_falsed = True #: (INTERNAL) Falsed easting and northing (C{bool}). 

_hemisphere = '' #: (INTERNAL) Hemisphere ('N' or 'S'), different from pole. 

_latlon = None #: (INTERNAL) toLatLon cache (C{LatLon}). 

_latlon_args = None #: (INTERNAL) toLatLon args (varies). 

_mgrs = None #: (INTERNAL) toMgrs cache (L{Mgrs}. 

_northing = 0 #: (INTERNAL) Northing, see B{C{falsed}} (C{meter}). 

_scale = None #: (INTERNAL) Grid scale factor (C{scalar}) or C{None}. 

# _scale0 = _K0 #: (INTERNAL) Central scale factor (C{scalar}). 

_ups = None #: (INTERNAL) toUps cache (L{Ups}). 

_utm = None #: (INTERNAL) toUtm cache (L{Utm}). 

 

def __repr__(self): 

return self.toStr2(B=True) 

 

def __str__(self): 

return self.toStr() 

 

@property_RO 

def convergence(self): 

'''Get the meridian convergence (C{degrees}) or C{None}. 

''' 

return self._convergence 

 

@property_RO 

def datum(self): 

'''Get the datum (L{Datum}). 

''' 

return self._datum 

 

@property_RO 

def easting(self): 

'''Get the easting (C{meter}). 

''' 

return self._easting 

 

def to2en(self, falsed=True): 

'''Return easting and northing, falsed or unfalsed. 

 

@keyword falsed: Return easting and northing falsed 

(C{bool}), otherwise unfalsed. 

 

@return: An L{EasNor2Tuple}C{(easting, northing)}. 

''' 

e, n = self.falsed2 

if self.falsed and not falsed: 

e, n = -e, -n 

elif falsed and not self.falsed: 

pass 

else: 

e = n = 0 

return EasNor2Tuple(e + self.easting, n + self.northing) 

 

@property_RO 

def falsed(self): 

'''Get easting and northing falsed (C{bool}). 

''' 

return self._falsed 

 

@property_RO 

def falsed2(self): 

'''(INTERNAL) I{Must be overloaded}. 

''' 

self._notOverloaded(self.falsed2.__name__) 

 

@property_RO 

def hemisphere(self): 

'''Get the hemisphere (C{str}, 'N'|'S'). 

''' 

return self._hemisphere 

 

def _latlon5(self, LatLon): 

'''(INTERNAL) Convert cached LatLon 

''' 

ll = self._latlon 

if LatLon is None: 

r = LatLonDatum5Tuple(ll.lat, ll.lon, ll.datum, 

ll.convergence, ll.scale) 

elif issubclassof(LatLon, _LLEB): 

r = _xattrs(LatLon(ll.lat, ll.lon, datum=ll.datum), 

ll, '_convergence', '_scale') 

else: 

raise _IsNotError(_LLEB.__name__, LatLon=LatLon) 

return _xnamed(r, ll.name) 

 

@property_RO 

def northing(self): 

'''Get the northing (C{meter}). 

''' 

return self._northing 

 

@property_RO 

def scale(self): 

'''Get the grid scale (C{float}) or C{None}. 

''' 

return self._scale 

 

@property_RO 

def scale0(self): 

'''Get the central scale factor (C{float}). 

''' 

return self._scale0 

 

def toEpsg(self): 

'''Determine the B{EPSG (European Petroleum Survey Group)} code. 

 

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

 

@raise EPSGError: See L{Epsg}. 

''' 

if self._epsg is None: 

from pygeodesy.epsg import Epsg # PYCHOK circular import 

self._epsg = Epsg(self) 

return self._epsg 

 

def _toStr4_6(self, hemipole, B, cs, prec, sep): 

'''(INTERNAL) Return a string representation of this UTM/UPS coordinate. 

''' 

z = '%02d%s' % (self.zone, (self.band if B else '')) # PYCHOK band 

t = (z, hemipole, fStr(self.easting, prec=prec), 

fStr(self.northing, prec=prec)) 

if cs: 

t += ('n/a' if self.convergence is None else 

degDMS(self.convergence, prec=8, pos='+'), 

'n/a' if self.scale is None else 

fStr(self.scale, prec=8)) 

return sep.join(t) 

 

def _toStr2(self, prec=0, fmt='[%s]', sep=', ', B=False, cs=False): # PYCHOK expected 

'''(INTERNAL) Return a string representation of this UTM/UPS coordinate. 

''' 

t = self.toStr(prec=prec, sep=' ', B=B, cs=cs).split() 

return fmt % (sep.join('%s:%s' % t for t in zip('ZHENCS', t)),) 

 

# **) MIT License 

# 

# Copyright (C) 2016-2020 -- 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.