# Coverage for pygeodesy/utmups.py : 98%

## 87 statements 85 run 2 missing 13 excluded

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 | # -*- coding: utf-8 -*- u'''I{Karney}'s UTM and UPS utilities. Functions L{parseUTMUPS5}, L{toUtmUps8}, L{UtmUps} and L{utmupsZoneBand5} to handle both I{Universal Transverse Mercator} (U{UTM <https://WikiPedia.org/wiki/Universal_Transverse_Mercator_coordinate_system>}) and I{Universal Polar Stereographic} (U{UPS <https://WikiPedia.org/wiki/Universal_polar_stereographic_coordinate_system>}) coordinates. A pure Python implementation, partially transcoded from C++ class U{UTMUPS <https://GeographicLib.SourceForge.io/C++/doc/classGeographicLib_1_1UTMUPS.html>} by I{Charles Karney}. ''' # from pygeodesy.basics import map1 # from .utmupsBase # from pygeodesy.datums import _WGS84 # from .utmupsBase from pygeodesy.errors import _IsnotError, RangeError, _ValueError, _xkwds_get from pygeodesy.interns import NN, _easting_, _MGRS_, _northing_, _NS_, \ _outside_, _range_, _SPACE_, _UPS_, _UTM_ from pygeodesy.lazily import _ALL_LAZY, _ALL_MODS as _MODS from pygeodesy.named import modulename from pygeodesy.namedTuples import UtmUps5Tuple, UtmUps8Tuple # from pygeodesy.streprs import Fmt # from .utmupsBase from pygeodesy.units import Northing, _100km from pygeodesy.ups import parseUPS5, toUps8, Ups, UPSError, upsZoneBand5 from pygeodesy.utm import parseUTM5, toUtm8, Utm, UTMError, utmZoneBand5 from pygeodesy.utmupsBase import Fmt, map1, _to4lldn, _to3zBhp, \ _UPS_ZONE, _UPS_ZONE_STR, _UTMUPS_ZONE_MIN, \ _UTMUPS_ZONE_MAX, _WGS84 __all__ = _ALL_LAZY.utmups __version__ = '22.10.04' _MGRS_TILE = _100km # in .mgrs.Mgrs.tile _UPS_N_MAX = Northing( 27 * _MGRS_TILE) _UPS_N_MIN = Northing( 13 * _MGRS_TILE) _UPS_S_MAX = Northing( 32 * _MGRS_TILE) _UPS_S_MIN = Northing( 8 * _MGRS_TILE) _UTM_C_MAX = Northing( 9 * _MGRS_TILE) _UTM_C_MIN = Northing( 1 * _MGRS_TILE) _UTM_N_MAX = Northing( 95 * _MGRS_TILE) _UTM_N_MIN = Northing( 0 * _MGRS_TILE) _UTM_S_MAX = Northing(100 * _MGRS_TILE) _UTM_S_MIN = Northing( 10 * _MGRS_TILE) _UTM_N_SHIFT = _UTM_S_MAX - _UTM_N_MIN # South minus North UTM northing class _UpsMinMax(object): # XXX _NamedEnum or _NamedTuple # UPS ranges for North, South pole eMax = _UPS_N_MAX, _UPS_S_MAX eMin = _UPS_N_MIN, _UPS_S_MIN nMax = _UPS_N_MAX, _UPS_S_MAX nMin = _UPS_N_MIN, _UPS_S_MIN class _UtmMinMax(object): # XXX _NamedEnum or _NamedTuple # UTM ranges for Northern, Southern hemisphere eMax = _UTM_C_MAX, _UTM_C_MAX eMin = _UTM_C_MIN, _UTM_C_MIN nMax = _UTM_N_MAX, Northing(_UTM_N_MAX + _UTM_N_SHIFT) nMin = Northing(_UTM_S_MIN - _UTM_N_SHIFT), _UTM_S_MIN class UTMUPSError(_ValueError): # XXX (UTMError, UPSError) '''Universal Transverse Mercator/Universal Polar Stereographic (UTM/UPS) parse, validate or other issue. ''' pass def parseUTMUPS5(strUTMUPS, datum=_WGS84, Utm=Utm, Ups=Ups, name=NN): '''Parse a string representing a UTM or UPS coordinate, consisting of C{"zone[band] hemisphere/pole easting northing"}. @arg strUTMUPS: A UTM or UPS coordinate (C{str}). @kwarg datum: Optional datum to use (L{Datum}). @kwarg Utm: Optional class to return the UTM coordinate (L{Utm}) or C{None}. @kwarg Ups: Optional class to return the UPS coordinate (L{Ups}) or C{None}. @kwarg name: Optional instance name (C{str}). @return: The UTM or UPS instance (B{C{Utm}} or B{C{Ups}}) or a L{UtmUps5Tuple}C{(zone, hemipole, easting, northing, band)} if B{C{Utm}} respectively B{C{Ups}} or both are C{None}. The C{hemipole} is C{'N'|'S'}, the UTM hemisphere or UPS pole, the UPS projection top/center. @raise UTMUPSError: Invalid B{C{strUTMUPS}}. @see: Functions L{pygeodesy.parseUTM5} and L{pygeodesy.parseUPS5}. ''' try: try: u = parseUTM5(strUTMUPS, datum=datum, Utm=Utm, name=name) except UTMError: u = parseUPS5(strUTMUPS, datum=datum, Ups=Ups, name=name) return u except (UTMError, UPSError) as x: raise UTMUPSError(strUTMUPS=strUTMUPS, cause=x) def toUtmUps8(latlon, lon=None, datum=None, falsed=True, Utm=Utm, Ups=Ups, pole=NN, name=NN, **cmoff): '''Convert a lat-/longitude point to a UTM or UPS coordinate. @arg latlon: Latitude (C{degrees}) or an (ellipsoidal) geodetic C{LatLon} point. @kwarg lon: Optional longitude (C{degrees}) or C{None}. @kwarg datum: Optional datum to use this UTM coordinate, overriding B{C{latlon}}'s datum (C{Datum}). @kwarg falsed: False both easting and northing (C{bool}). @kwarg Utm: Optional class to return the UTM coordinate (L{Utm}) or C{None}. @kwarg Ups: Optional class to return the UPS coordinate (L{Ups}) or C{None}. @kwarg pole: Optional top/center of UPS (stereographic) projection (C{str}, C{'N[orth]'} or C{'S[outh]'}). @kwarg name: Optional name (C{str}). @kwarg cmoff: DEPRECATED, use B{C{falsed}}. Offset longitude from zone's central meridian, for UTM only (C{bool}). @return: The UTM or UPS coordinate (B{C{Utm}} respectively B{C{Ups}}) or a L{UtmUps8Tuple}C{(zone, hemipole, easting, northing, band, datum, gamma, scale)} if B{C{Utm}} respectively B{C{Ups}} is C{None} or B{C{cmoff}} is C{False}. @raise RangeError: If B{C{lat}} outside the valid UTM or UPS bands or if B{C{lat}} or B{C{lon}} outside the valid range and L{pygeodesy.rangerrors} set to C{True}. @raise TypeError: If B{C{latlon}} is not ellipsoidal or B{C{lon}} value is missing of B{C{datum}} is invalid. @raise UTMUPSError: UTM or UPS validation failed. @raise ValueError: Invalid B{C{lat}} or B{C{lon}}. @see: Functions L{pygeodesy.toUtm8} and L{pygeodesy.toUps8}. ''' lat, lon, d, name = _to4lldn(latlon, lon, datum, name) z, B, p, lat, lon = utmupsZoneBand5(lat, lon) f = falsed and _xkwds_get(cmoff, cmoff=True) if z == _UPS_ZONE: u = toUps8(lat, lon, datum=d, falsed=f, Ups=Ups, pole=pole or p, name=name) else: u = toUtm8(lat, lon, datum=d, falsed=f, Utm=Utm, name=name) return u def UtmUps(zone, hemipole, easting, northing, band=NN, datum=_WGS84, falsed=True, name=NN): '''Class-like function to create a UTM/UPS coordinate. @kwarg zone: The UTM zone with/-out I{longitudinal} Band or UPS zone C{0} or C{"00"} with/-out I{polar} Band (C{str} or C{int}). @kwarg hemipole: UTM hemisphere or UPS top/center of projection (C{str}, C{'N[orth]'} or C{'S[outh]'}). @arg easting: Easting, see B{C{falsed}} (C{meter}). @arg northing: Northing, see B{C{falsed}} (C{meter}). @kwarg band: Optional, UTM I{latitudinal} C{'C'|'D'|..|'W'|'X'} or UPS I{polar} Band letter C{'A'|'B'|'Y'|'Z'} Band letter (C{str}). @kwarg datum: Optional, the coordinate's datum (L{Datum}). @kwarg falsed: Both B{C{easting}} and B{C{northing}} are falsed (C{bool}). @kwarg name: Optional name (C{str}). @return: New UTM or UPS instance (L{Utm} or L{Ups}). @raise TypeError: Invalid B{C{datum}}. @raise UTMUPSError: UTM or UPS validation failed. @see: Classes L{Utm} and L{Ups} and I{Karney}'s U{UTMUPS <https://GeographicLib.SourceForge.io/C++/doc/classGeographicLib_1_1UTMUPS.html>}. ''' z, B, hp = _to3zBhp(zone, band, hemipole=hemipole) U = Ups if z in (_UPS_ZONE, _UPS_ZONE_STR) else Utm return U(z, hp, easting, northing, band=B, datum=datum, falsed=falsed, name=name) def utmupsValidate(coord, falsed=False, MGRS=False, Error=UTMUPSError): '''Check a UTM or UPS coordinate. @arg coord: The UTM or UPS coordinate (L{Utm}, L{Etm}, L{Ups} or C{5+Tuple}). @kwarg falsed: C{5+Tuple} easting and northing are falsed (C{bool}), ignored otherwise. @kwarg MGRS: Increase easting and northing ranges (C{bool}). @kwarg Error: Optional error to raise, overriding the default (L{UTMUPSError}). @return: C{None} if validation passed. @raise Error: Validation failed. @see: Function L{utmupsValidateOK}. ''' def _en(en, lo, hi, ename): # U, Error try: if lo <= float(en) <= hi: return except (TypeError, ValueError): pass t = _SPACE_(_outside_, U, _range_, _range_(lo, hi)) raise Error(ename, en, txt=t) if isinstance(coord, (Ups, Utm)): hemi = coord.hemisphere enMM = coord.falsed elif isinstance(coord, (UtmUps5Tuple, UtmUps8Tuple)): hemi = coord.hemipole enMM = falsed else: raise _IsnotError(Error=Error, coord=coord, *map1(modulename, Utm, Ups, UtmUps5Tuple, UtmUps8Tuple)) band = coord.band zone = coord.zone z, B, h = _to3zBhp(zone, band, hemipole=hemi) if z == _UPS_ZONE: # UPS u, U, M = _MODS.ups, _UPS_, _UpsMinMax else: # UTM u, U, M = _MODS.utm, _UTM_, _UtmMinMax if MGRS: U, s = _MGRS_, _MGRS_TILE else: s = 0 i = _NS_.find(h) if i < 0 or z < _UTMUPS_ZONE_MIN \ or z > _UTMUPS_ZONE_MAX \ or B not in u._Bands: t = Fmt.PAREN(U, repr(_SPACE_(NN(Fmt.zone(z), B), h))) raise Error(coord=t, zone=zone, band=band, hemisphere=hemi) if enMM: _en(coord.easting, M.eMin[i] - s, M.eMax[i] + s, _easting_) # PYCHOK .eMax .eMin _en(coord.northing, M.nMin[i] - s, M.nMax[i] + s, _northing_) # PYCHOK .nMax .nMin def utmupsValidateOK(coord, falsed=False, ok=True): '''Check a UTM or UPS coordinate. @arg coord: The UTM or UPS coordinate (L{Utm}, L{Ups} or C{5+Tuple}). @kwarg falsed: C{5+Tuple} easting and northing are falsed (C{bool}). @kwarg ok: Result to return if validation passed (B{C{ok}}). @return: B{C{ok}} if validation passed, the L{UTMUPSError} otherwise. @see: Function L{utmupsValidate}. ''' try: utmupsValidate(coord, falsed=falsed) return ok except UTMUPSError as x: return x def utmupsZoneBand5(lat, lon, cmoff=False, name=NN): '''Return the UTM/UPS zone number, Band letter, hemisphere/pole and clipped lat- and longitude for a given location. @arg lat: Latitude in degrees (C{scalar} or C{str}). @arg lon: Longitude in degrees (C{scalar} or C{str}). @kwarg cmoff: Offset longitude from the zone's central meridian, for UTM only (C{bool}). @kwarg name: Optional name (C{str}). @return: A L{UtmUpsLatLon5Tuple}C{(zone, band, hemipole, lat, lon)} where C{hemipole} is C{'N'|'S'}, the UTM hemisphere or UPS pole, the UPS projection top/center. @raise RangeError: If B{C{lat}} outside the valid UTM or UPS bands or if B{C{lat}} or B{C{lon}} outside the valid range and L{pygeodesy.rangerrors} set to C{True}. @raise ValueError: Invalid B{C{lat}} or B{C{lon}}. @see: Functions L{pygeodesy.utmZoneBand5} and L{pygeodesy.upsZoneBand5}. ''' try: return utmZoneBand5(lat, lon, cmoff=cmoff, name=name) except RangeError: return upsZoneBand5(lat, lon, name=name) # **) MIT License # # Copyright (C) 2016-2023 -- 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.