# Coverage for pygeodesy/elevations.py : 100%

## 70 statements 70 run 0 missing 35 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 | # -*- coding: utf-8 -*- u'''Web-services-based elevations and geoid heights. Functions to obtain elevations and geoid heights thru web services, for (lat, lon) locations, currently limited to the U{Conterminous US (CONUS)<https://WikiPedia.org/wiki/Contiguous_United_States>}, see also modules L{pygeodesy.geoids} and L{pygeodesy.heights} and U{USGS10mElev.py<https://Gist.GitHub.com/pyRobShrk>}. B{macOS}: If an C{SSLCertVerificationError} occurs, especially this I{"[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: self "signed certificate in certificate chain ..."}, review U{this post<https://StackOverflow.com/questions/27835619/ urllib-and-ssl-certificate-verify-failed-error>} for a remedy. From a C{Terminal} window run: C{"/Applications/Python\\ X.Y/Install\\ Certificates.command"} ''' from pygeodesy.basics import clips, ub2str from pygeodesy.errors import ParseError, _xkwds_get from pygeodesy.interns import NN, _AMPERSAND_, _COLONSPACE_, \ _elevation_, _height_, _LCURLY_, \ _n_a_, _no_, _RCURLY_, _SPACE_ from pygeodesy.lazily import _ALL_LAZY from pygeodesy.named import _NamedTuple from pygeodesy.streprs import Fmt, fstr, lrstrip from pygeodesy.units import Lat, Lon, Meter, Scalar, Str __all__ = _ALL_LAZY.elevations __version__ = '22.10.28' try: from urllib2 import urlopen # quote, urlcleanup from httplib import HTTPException as HTTPError except (ImportError, NameError): # Python 3+ from urllib.request import urlopen # urlcleanup # from urllib.parse import quote from urllib.error import HTTPError _JSON_ = 'JSON' _QUESTION_ = '?' _XML_ = 'XML' try: from json import loads as _json except ImportError: from pygeodesy.interns import _COMMA_, _QUOTE2_ _QUOTE2COLONSPACE_ = _QUOTE2_ + _COLONSPACE_ def _json(ngs): '''(INTERNAL) Convert an NGS response in JSON to a C{dict}. ''' # b'{"geoidModel": "GEOID12A", # "station": "UserStation", # "lat": 37.8816, # "latDms": "N375253.76000", # "lon": -121.9142, # "lonDms": "W1215451.12000", # "geoidHeight": -31.703, # "error": 0.064 # }' # # or in case of errors: # # b'{"error": "No suitable Geoid model found for model 15" # }' d = {} for t in lrstrip(ngs.strip(), lrpairs={_LCURLY_: _RCURLY_}).split(_COMMA_): t = t.strip() j = t.strip(_QUOTE2_).split(_QUOTE2COLONSPACE_) if len(j) != 2: raise ParseError(json=t) k, v = j try: v = float(v) except (TypeError, ValueError): v = Str(ub2str(v.lstrip().lstrip(_QUOTE2_)), name=k) d[k] = v return d def _error(fun, lat, lon, e): '''(INTERNAL) Format an error ''' return _COLONSPACE_(Fmt.PAREN(fun.__name__, fstr((lat, lon))), e) def _qURL(url, timeout=2, **params): '''(INTERNAL) Build B{C{url}} query, get and verify response. ''' if params: # build url query, don't map(quote, params)! p = _AMPERSAND_(*(Fmt.EQUAL(p, v) for p, v in params.items() if v)) if p: url = NN(url, _QUESTION_, p) u = urlopen(url, timeout=timeout) # secs s = u.getcode() if s != 200: # http.HTTPStatus.OK or http.client.OK raise HTTPError('code %d: %s' % (s, u.geturl())) r = u.read() u.close() # urlcleanup() return ub2str(r).strip() def _xml(tag, xml): '''(INTERNAL) Get a <tag>value</tag> from XML. ''' # b'<?xml version="1.0" encoding="utf-8" ?> # <USGS_Elevation_Point_Query_Service> # <Elevation_Query x="-121.914200" y="37.881600"> # <Data_Source>3DEP 1/3 arc-second</Data_Source> # <Elevation>3851.03</Elevation> # <Units>Feet</Units> # </Elevation_Query> # </USGS_Elevation_Point_Query_Service>' i = xml.find(Fmt.TAG(tag)) if i > 0: i += len(tag) + 2 j = xml.find(Fmt.TAGEND(tag), i) if j > i: return Str(xml[i:j].strip(), name=tag) return _no_(_XML_, Fmt.TAG(tag)) # PYCHOK no cover class Elevation2Tuple(_NamedTuple): # .elevations.py '''2-Tuple C{(elevation, data_source)} in C{meter} and C{str}. ''' _Names_ = (_elevation_, 'data_source') _Units_ = ( Meter, Str) def elevation2(lat, lon, timeout=2.0): '''Get the geoid elevation at an C{NAD83} to C{NAVD88} location. @arg lat: Latitude (C{degrees}). @arg lon: Longitude (C{degrees}). @kwarg timeout: Optional, query timeout (seconds). @return: An L{Elevation2Tuple}C{(elevation, data_source)} or (C{None, "error"}) in case of errors. @raise ValueError: Invalid B{C{timeout}}. @note: The returned C{elevation} is C{None} if B{C{lat}} or B{C{lon}} is invalid or outside the C{Conterminous US (CONUS)}, if conversion failed or if the query timed out. The C{"error"} is the C{HTTP-, IO-, SSL-} or other C{-Error} as a string (C{str}). @see: U{USGS Elevation Point Query Service<https://NationalMap.gov/epqs>}, the U{FAQ<https://www.USGS.gov/faqs/what-are-projection-horizontal-and-vertical- datum-units-and-resolution-3dep-standard-dems>}, U{geoid.py<https://Gist.GitHub.com/ pyRobShrk>}, module L{geoids}, classes L{GeoidG2012B}, L{GeoidKarney} and L{GeoidPGM}. ''' try: # alt 'https://NED.USGS.gov/epqs/pqs.php' x = _qURL('https://NationalMap.USGS.gov/epqs/pqs.php', x=Lon(lon).toStr(prec=6), y=Lat(lat).toStr(prec=6), units='Meters', # 'Feet', capitalized output=_XML_.lower(), # _JSON_, lowercase only timeout=Scalar(timeout=timeout)) if x[:6] == '<?xml ': e = _xml('Elevation', x) try: e = float(e) if abs(e) < 1e6: return Elevation2Tuple(e, _xml('Data_Source', x)) e = 'non-CONUS %.2F' % (e,) except (TypeError, ValueError): pass else: # PYCHOK no cover e = _no_(_XML_, Fmt.QUOTE2(clips(x, limit=128, white=_SPACE_))) except Exception as x: # (HTTPError, IOError, TypeError, ValueError) e = repr(x) e = _error(elevation2, lat, lon, e) return Elevation2Tuple(None, e) class GeoidHeight2Tuple(_NamedTuple): # .elevations.py '''2-Tuple C{(height, model_name)}, geoid C{height} in C{meter} and C{model_name} as C{str}. ''' _Names_ = (_height_, 'model_name') _Units_ = ( Meter, Str) def geoidHeight2(lat, lon, model=0, timeout=2.0): '''Get the C{NAVD88} geoid height at an C{NAD83} location. @arg lat: Latitude (C{degrees}). @arg lon: Longitude (C{degrees}). @kwarg model: Optional, geoid model ID (C{int}). @kwarg timeout: Optional, query timeout (seconds). @return: An L{GeoidHeight2Tuple}C{(height, model_name)} or C{(None, "error"}) in case of errors. @raise ValueError: Invalid B{C{timeout}}. @note: The returned C{height} is C{None} if B{C{lat}} or B{C{lon}} is invalid or outside the C{Conterminous US (CONUS)}, if the B{C{model}} was invalid, if conversion failed or if the query timed out. The C{"error"} is the C{HTTP-, IO-, SSL-, URL-} or other C{-Error} as a string (C{str}). @see: U{NOAA National Geodetic Survey <https://www.NGS.NOAA.gov/INFO/geodesy.shtml>}, U{Geoid<https://www.NGS.NOAA.gov/web_services/geoid.shtml>}, U{USGS10mElev.py<https://Gist.GitHub.com/pyRobShrk>}, module L{geoids}, classes L{GeoidG2012B}, L{GeoidKarney} and L{GeoidPGM}. ''' try: j = _qURL('https://Geodesy.NOAA.gov/api/geoid/ght', lat=Lat(lat).toStr(prec=6), lon=Lon(lon).toStr(prec=6), model=(model if model else NN), timeout=Scalar(timeout=timeout)) # PYCHOK indent if j[:1] == _LCURLY_ and j[-1:] == _RCURLY_ and j.find('"error":') > 0: d, e = _json(j), 'geoidHeight' if isinstance(_xkwds_get(d, error=_n_a_), float): h = d.get(e, None) if h is not None: m = _xkwds_get(d, geoidModel=_n_a_) return GeoidHeight2Tuple(h, m) else: e = _JSON_ e = _no_(e, Fmt.QUOTE2(clips(j, limit=256, white=_SPACE_))) except Exception as x: # (HTTPError, IOError, ParseError, TypeError, ValueError) e = repr(x) e = _error(geoidHeight2, lat, lon, e) return GeoidHeight2Tuple(None, e) if __name__ == '__main__': # <https://WikiPedia.org/wiki/Mount_Diablo> for f in (elevation2, # (1173.79, '3DEP 1/3 arc-second') geoidHeight2): # (-31.699, u'GEOID12B') t = f(37.8816, -121.9142) print(_COLONSPACE_(f.__name__, t)) # **) 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. # % python -m pygeodesy.elevations # elevation2: (1173.79, '3DEP 1/3 arc-second') # geoidHeight2: (-31.703, 'GEOID12B')