# Coverage for pygeodesy/deprecated.py : 100%

## 96 statements 96 run 0 missing 40 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 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 | # -*- coding: utf-8 -*- u'''DEPRECATED classes, functions, etc. exported for backward compatibility. ''' from pygeodesy.basics import EPS from pygeodesy.heights import HeightIDWequirectangular as _HeightIDWequirectangular, \ HeightIDWeuclidean as _HeightIDWeuclidean, \ HeightIDWhaversine as _HeightIDWhaversine from pygeodesy.interns import _COMMA_SPACE_, _easting_, _hemipole_, NN, \ _northing_, _scalar_, _UNDERSCORE_, _zone_ from pygeodesy.lazily import _ALL_DOCS, _ALL_LAZY from pygeodesy.named import _NamedTuple from pygeodesy.trf import TRFError as _TRFError __all__ = _ALL_LAZY.deprecated __version__ = '20.07.08' OK = 'OK' # OK for test like I{if ... is OK: ...} _R_M = _WGS84 = _UTM = object() # DEPRECATED classes, for export only class HeightIDW(_HeightIDWeuclidean): # PYCHOK exported '''DEPRECATED, use class L{HeightIDWeuclidean}. ''' pass class HeightIDW2(_HeightIDWequirectangular): # PYCHOK exported '''DEPRECATED, use class L{HeightIDWequirectangular}. ''' pass class HeightIDW3(_HeightIDWhaversine): # PYCHOK exported '''DEPRECATED, use class L{HeightIDWhaversine}. ''' pass class RefFrameError(_TRFError): # PYCHOK exported '''DEPRECATED, use class L{TRFError}. ''' pass class UtmUps4Tuple(_NamedTuple): '''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 def anStr(name, OKd='._-', sub=_UNDERSCORE_): '''DEPRECATED, use function L{anstr}. ''' from pygeodesy.streprs import anstr return anstr(name, OKd=OKd, sub=sub) def areaof(points, adjust=True, radius=_R_M, wrap=True): '''DEPRECATED, use function L{areaOf}. ''' from pygeodesy.points import areaOf from pygeodesy.utily import R_M # PYCHOK shadows? r = R_M if radius is _R_M else radius # PYCHOK shadows? return areaOf(points, adjust=adjust, radius=r, wrap=wrap) def bounds(points, wrap=True, LatLon=None): '''DEPRECATED, use function L{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)) def clipDMS(deg, limit): # PYCHOK no cover '''DEPRECATED, use function L{clipDegrees}. ''' from pygeodesy.dms import clipDegrees return clipDegrees(deg, limit) def clipStr(bstr, limit=50, white=NN): '''DEPRECATED, use function L{clips}. ''' from pygeodesy.basics import clips return clips(bstr, limit=limit, white=white) def decodeEPSG2(arg): '''DEPRECATED, use function L{epsg.decode2}. @return: 2-Tuple C{(zone, hemipole)} ''' from pygeodesy.epsg import decode2 return tuple(decode2(arg)) def encodeEPSG(zone, hemipole=NN, band=NN): '''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)) def enStr2(easting, northing, prec, *extras): # PYCHOK no cover '''DEPRECATED, use function L{enstr2}. ''' from pygeodesy.streprs import enstr2 return enstr2(easting, northing, prec, *extras) def equirectangular3(lat1, lon1, lat2, lon2, **options): '''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]) 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}) 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 B{C{name=value}} pair. @return: The value (C{float}). @raise Error: Invalid or negative B{C{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) def fStr(floats, prec=6, fmt='%.*f', ints=False, sep=_COMMA_SPACE_): '''DEPRECATED, use function L{fstr}. ''' from pygeodesy.streprs import fstr return fstr(floats, prec=prec, fmt=fmt, ints=ints, sep=sep) def fStrzs(floatstr): # PYCHOK no cover '''DEPRECATED, use function L{fstrzs}. ''' from pygeodesy.streprs import fstrzs return fstrzs(floatstr) def hypot3(x, y, z): '''DEPRECATED, use function L{hypot_}. ''' from pygeodesy.fmath import hypot_ return hypot_(x, y, z) def inStr(inst, *args, **kwds): # PYCHOK no cover '''DEPRECATED, use function L{instr}. ''' from pygeodesy.streprs import instr return instr(inst, *args, **kwds) def isenclosedby(point, points, wrap=False): '''DEPRECATED, use function L{isenclosedBy}. ''' from pygeodesy.points import isenclosedBy return isenclosedBy(point, points, wrap=wrap) def nearestOn3(point, points, closed=False, wrap=False, **options): '''DEPRECATED, use function L{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]) def nearestOn4(point, points, closed=False, wrap=False, **options): '''DEPRECATED, use function L{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]) def parseUTM(strUTM, datum=_WGS84, Utm=_UTM, name=NN): '''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.datum 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 def perimeterof(points, closed=False, adjust=True, radius=_R_M, wrap=True): '''DEPRECATED, use function L{perimeterOf}. ''' from pygeodesy.points import perimeterOf from pygeodesy.utily import R_M # PYCHOK shadows? r = R_M if radius is _R_M else radius # PYCHOK shadows? return perimeterOf(points, closed=closed, adjust=adjust, radius=r, wrap=wrap) def polygon(points, closed=True, base=None): '''DEPRECATED, use function L{points2}. ''' from pygeodesy.bases import points2 return points2(points, closed=closed, base=base) def scalar(value, low=EPS, high=1.0, name=_scalar_, Error=ValueError): # PYCHOK no cover '''DEPRECATED, use class L{Number_} or L{Scalar_}. @arg value: The value (C{scalar}). @kwarg low: Optional lower bound (C{scalar}). @kwarg high: Optional upper bound (C{scalar}). @kwarg name: Optional name of value (C{str}). @kwarg Error: Exception to raise (C{ValueError}). @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 from pygeodesy.units import Number_, Scalar_ C_ = Number_ if isint(low) else Scalar_ return C_(value, name=name, Error=Error, low=low, high=high) def simplify2(points, pipe, radius=_R_M, shortest=False, indices=False, **options): '''DEPRECATED, use function L{simplifyRW}. ''' from pygeodesy.simplify import simplifyRW from pygeodesy.utily import R_M # PYCHOK shadows? r = R_M if radius is _R_M else radius # PYCHOK shadows? return simplifyRW(points, pipe, radius=r, shortest=shortest, indices=indices, **options) def toUtm(latlon, lon=None, datum=None, Utm=_UTM, cmoff=True, name=NN): '''DEPRECATED, use function L{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 def unStr(name, *args, **kwds): '''DEPRECATED, use function L{unstr}. ''' from pygeodesy.streprs import unstr return unstr(name, *args, **kwds) def utmZoneBand2(lat, lon): '''DEPRECATED, use function L{utmZoneBand5}. @return: 2-Tuple C{(zone, band)}. ''' from pygeodesy.utm import utmZoneBand5 r = utmZoneBand5(lat, lon) # UtmUpsLatLon5Tuple return r.zone, r.band __all__ += _ALL_DOCS(UtmUps4Tuple) # **) MIT License # # Copyright (C) 2018-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.