# Coverage for pygeodesy/css.py : 97%

## 197 statements 191 run 6 missing 3 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 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 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 | # -*- coding: utf-8 -*- u'''Cassini-Soldner (CSS) projection. Classes L{CassiniSoldner}, L{Css} and L{CSSError} requiring I{Charles Karney}'s U{geographiclib <https://PyPI.org/project/geographiclib>} Python package to be installed. ''' from pygeodesy.basics import copysign0, neg, _xinstanceof, _xsubclassof from pygeodesy.datums import _ellipsoidal_datum, _WGS84 from pygeodesy.ellipsoidalBase import LatLonEllipsoidalBase as _LLEB from pygeodesy.errors import _datum_datum, _ValueError, \ _xellipsoidal, _xkwds from pygeodesy.interns import NN, _azimuth_, _COMMASPACE_, _datum_, \ _easting_, _lat_, _lon_, _m_, _name_, \ _northing_, _reciprocal_, _SPACE_, \ _0_0, _0_5, _1_0, _90_0, _360_0 from pygeodesy.interns import _C_ # PYCHOK used! from pygeodesy.lazily import _ALL_LAZY from pygeodesy.named import _NamedBase, _NamedTuple, nameof from pygeodesy.namedTuples import EasNor2Tuple, EasNor3Tuple, \ LatLon2Tuple, LatLon4Tuple, _LL4Tuple from pygeodesy.props import deprecated_Property_RO, Property_RO from pygeodesy.streprs import Fmt, _fstrENH2, _fstrLL0, _xzipairs from pygeodesy.units import Bearing, Easting, Height, Lat_, Lon_, \ Northing, Scalar __all__ = _ALL_LAZY.css __version__ = '21.07.31' def _CS0(cs0): '''(INTERNAL) Get/set default projection. ''' if cs0 is None: cs0 = Css._CS0 if cs0 is None: Css._CS0 = cs0 = CassiniSoldner(_0_0, _0_0, name='Default') else: _xinstanceof(CassiniSoldner, cs0=cs0) return cs0 class CSSError(_ValueError): '''Cassini-Soldner (CSS) conversion or other L{Css} issue. ''' pass class CassiniSoldner(_NamedBase): '''Cassini-Soldner projection, a Python version of I{Karney}'s C++ class U{CassiniSoldner <https://GeographicLib.SourceForge.io/html/classGeographicLib_1_1CassiniSoldner.html>}. ''' _cb0 = _0_0 _datum = _WGS84 # L{Datum} _latlon0 = () _meridian = None _sb0 = _0_0 def __init__(self, lat0, lon0, datum=_WGS84, name=NN): '''New L{CassiniSoldner} projection. @arg lat0: Latitude of center point (C{degrees90}). @arg lon0: Longitude of center point (C{degrees180}). @kwarg datum: Optional datum or ellipsoid (L{Datum}, L{Ellipsoid}, L{Ellipsoid2} or L{a_f2Tuple}). @kwarg name: Optional name (C{str}). @raise CSSError: Invalid B{C{lat}} or B{C{lon}}. @raise ImportError: Package U{geographiclib<https://PyPI.org/ project/geographiclib>} not installed or not found. @example: >>> p = CassiniSoldner(48 + 50/60.0, 2 + 20/60.0) # Paris >>> p.forward(50.9, 1.8) # Calais (-37518.854545, 230003.561828) >>> p.reverse4(-38e3, 230e3) (50.899937, 1.793161, 89.580797, 0.999982) ''' if datum not in (None, self._datum): self._datum = _xellipsoidal(datum=_ellipsoidal_datum(datum, name=name)) if name: self.name = name self.reset(lat0, lon0) @Property_RO def datum(self): '''Get the datum (L{Datum}). ''' return self._datum def _datumatch(self, latlon): '''Check for matching datum ellipsoids. @raise CSSError: Ellipsoidal mismatch of B{C{latlon}} and this projection. ''' _datum_datum(self.datum, latlon.datum, Error=CSSError) @Property_RO def equatoradius(self): '''Get the geodesic's equatorial radius, semi-axis (C{meter}). ''' return self.geodesic.a @Property_RO def flattening(self): '''Get the geodesic's flattening (C{float}). ''' return self.geodesic.f def forward(self, lat, lon): '''Convert an (ellipsoidal) geodetic location to Cassini-Soldner easting and northing. @arg lat: Latitude of the location (C{degrees90}). @arg lon: Longitude of the location (C{degrees180}). @return: An L{EasNor2Tuple}C{(easting, northing)}. @see: Methods L{CassiniSoldner.forward4}, L{CassiniSoldner.reverse} and L{CassiniSoldner.reverse4}. @raise CSSError: Invalid B{C{lat}} or B{C{lon}}. ''' t = self.forward4(lat, lon) return EasNor2Tuple(t.easting, t.northing, name=self.name) def forward4(self, lat, lon, name=NN): '''Convert an (ellipsoidal) geodetic location to Cassini-Soldner easting and northing. @arg lat: Latitude of the location (C{degrees90}). @arg lon: Longitude of the location (C{degrees180}). @kwarg name: Name inlieu of this projection's name (C{str}). @return: An L{EasNorAziRk4Tuple}C{(easting, northing, azimuth, reciprocal)}. @see: Method L{CassiniSoldner.forward}, L{CassiniSoldner.reverse} and L{CassiniSoldner.reverse4}. @raise CSSError: Invalid B{C{lat}} or B{C{lon}}. ''' g, M = self.datum.ellipsoid._geodesic_Math2 lat = Lat_(lat, Error=CSSError) d = M.AngDiff(self.lon0, Lon_(lon, Error=CSSError))[0] # _2sum r = g.Inverse(lat, -abs(d), lat, abs(d)) z1, a = r.azi1, (r.a12 * _0_5) z2, e = r.azi2, (r.s12 * _0_5) if e == 0: z = M.AngDiff(z1, z2)[0] * _0_5 # _2sum c = -90 if abs(d) > 90 else 90 z1, z2 = c - z, c + z if d < 0: a, e, z2 = neg(a), neg(e), z1 # z: azimuth of easting direction z = M.AngNormalize(z2) p = g.Line(lat, d, z, g.DISTANCE | g.GEODESICSCALE) # rk: reciprocal of azimuthal northing scale rk = p.ArcPosition(neg(a), g.GEODESICSCALE).M21 # rk = p._GenPosition(True, -a, g.DISTANCE)[7] # s, c = M.sincosd(p.EquatorialAzimuth()) s, c = M.sincosd(M.atan2d(p._salp0, p._calp0)) sb1 = copysign0(c, lat) # -c if lat < 0 else c cb1 = copysign0(s, 90 - abs(d)) # -abs(s) if abs(d) > 90 else abs(s) d = M.atan2d(sb1 * self._cb0 - cb1 * self._sb0, cb1 * self._cb0 + sb1 * self._sb0) n = self._meridian.ArcPosition(d, g.DISTANCE).s12 # n = self._meridian._GenPosition(True, d, g.DISTANCE)[4] return EasNorAziRk4Tuple(e, n, z, rk, name=name or self.name) @Property_RO def geodesic(self): '''Get this projection's I{wrapped} U{Karney Geodesic <https://GeographicLib.SourceForge.io/html/python/code.html>}, provided package U{geographiclib <https://PyPI.org/project/geographiclib>} is installed. ''' return self.datum.ellipsoid.geodesic @Property_RO def lat0(self): '''Get the center latitude (C{degrees90}). ''' return self._latlon0.lat @property def latlon0(self): '''Get the center lat- and longitude (L{LatLon2Tuple}C{(lat, lon)}) in (C{degrees90}, (C{degrees180}). ''' return self._latlon0 @latlon0.setter # PYCHOK setter! def latlon0(self, latlon0): '''Set the center lat- and longitude (L{LatLon2Tuple}, ellipsoidal C{LatLon} or L{LatLon4Tuple}). @raise CSSError: Invalid B{C{latlon0}} or ellipsoidal mismatch of B{C{latlon0}} and this projection. ''' _xinstanceof(_LLEB, LatLon4Tuple, LatLon2Tuple, latlon0=latlon0) if hasattr(latlon0, _datum_): self._datumatch(latlon0) self.reset(latlon0.lat, latlon0.lon) @Property_RO def lon0(self): '''Get the center longitude (C{degrees180}). ''' return self._latlon0.lon @deprecated_Property_RO def majoradius(self): # PYCHOK no cover '''DEPRECATED, use property C{equatoradius}.''' return self.equatoradius def reset(self, lat0, lon0): '''Set or reset the center point of this Cassini-Soldner projection. @arg lat0: Center point latitude (C{degrees90}). @arg lon0: Center point longitude (C{degrees180}). @raise CSSError: Invalid B{C{lat0}} or B{C{lon0}}. ''' self._update(True) # force reset g, M = self.datum.ellipsoid._geodesic_Math2 self._meridian = m = g.Line(Lat_(lat0=lat0, Error=CSSError), Lon_(lon0=lon0, Error=CSSError), _0_0, g.STANDARD | g.DISTANCE_IN) self._latlon0 = LatLon2Tuple(m.lat1, m.lon1) s, c = M.sincosd(m.lat1) # == self.lat0 == self.LatitudeOrigin() self._sb0, self._cb0 = M.norm(s * (_1_0 - g.f), c) def reverse(self, easting, northing, LatLon=None, **LatLon_kwds): '''Convert a Cassini-Soldner location to (ellipsoidal) geodetic lat- and longitude. @arg easting: Easting of the location (C{meter}). @arg northing: Northing of the location (C{meter}). @kwarg LatLon: Optional, ellipsoidal class to return the geodetic location as (C{LatLon}) or C{None}. @kwarg LatLon_kwds: Optional (C{LatLon}) keyword arguments, ignored if C{B{LatLon} is None}. @return: Geodetic location B{C{LatLon}} or if B{C{LatLon}} is C{None}, a L{LatLon2Tuple}C{(lat, lon)}. @raise CSSError: Ellipsoidal mismatch of B{C{LatLon}} and this projection. @raise TypeError: Invalid B{C{LatLon}} or B{C{LatLon_kwds}}. @see: Method L{CassiniSoldner.reverse4}, L{CassiniSoldner.forward} and L{CassiniSoldner.forward4}. ''' r = self.reverse4(easting, northing) if LatLon is None: r = LatLon2Tuple(r.lat, r.lon, name=self.name) # PYCHOK expected else: _xsubclassof(_LLEB, LatLon=LatLon) kwds = _xkwds(LatLon_kwds, datum=self.datum) r = self._xnamed(LatLon(r.lat, r.lon, **kwds)) # PYCHOK expected self._datumatch(r) return r def reverse4(self, easting, northing, name=NN): '''Convert a Cassini-Soldner location to (ellipsoidal) geodetic lat- and longitude. @arg easting: Easting of the location (C{meter}). @arg northing: Northing of the location (C{meter}). @kwarg name: Name inlieu of this projection's name (C{str}). @return: A L{LatLonAziRk4Tuple}C{(lat, lon, azimuth, reciprocal)}. @see: Method L{CassiniSoldner.reverse}, L{CassiniSoldner.forward} and L{CassiniSoldner.forward4}. ''' g = self.geodesic n = self._meridian.Position(northing) r = g.Direct(n.lat2, n.lon2, n.azi2 + _90_0, easting, g.STANDARD | g.GEODESICSCALE) z = (r.azi2 + _360_0) % _360_0 # include azimuth of easting direction and reciprocal of # azimuthal northing scale (see C++ member Direct() 5/6 # <https://GeographicLib.SourceForge.io/html/classGeographicLib_1_1Geodesic.html>) return LatLonAziRk4Tuple(r.lat2, r.lon2, z, r.M12, name=name or self.name) toLatLon = reverse # XXX not reverse4 def toRepr(self, prec=6, **unused): # PYCHOK expected '''Return a string representation of this projection. @kwarg prec: Optional number of decimals, unstripped (C{int}). @return: This projection as C{"<classname>(lat0, lon0, ...)"} (C{str}). ''' return _fstrLL0(self, prec, True) def toStr(self, prec=6, sep=_SPACE_, **unused): # PYCHOK expected '''Return a string representation of this projection. @kwarg prec: Optional number of decimal, unstripped (C{int}). @kwarg sep: Optional separator to join (C{str}). @return: This projection as C{"lat0 lon0"} (C{str}). ''' t = _fstrLL0(self, prec, False) return t if sep is None else sep.join(t) class Css(_NamedBase): '''Cassini-Soldner East-/Northing location. ''' _CS0 = None # default projection (L{CassiniSoldner}) _cs0 = None # projection (L{CassiniSoldner}) _easting = _0_0 # easting (C{float}) _height = 0 # height (C{meter}) _northing = _0_0 # northing (C{float}) def __init__(self, e, n, h=0, cs0=None, name=NN): '''New L{Css} Cassini-Soldner position. @arg e: Easting (C{meter}). @arg n: Northing (C{meter}). @kwarg h: Optional height (C{meter}). @kwarg cs0: Optional, the Cassini-Soldner projection (L{CassiniSoldner}). @kwarg name: Optional name (C{str}). @return: The Cassini-Soldner location (L{Css}). @raise CSSError: If B{C{e}} or B{C{n}} is invalid. @raise ImportError: Package U{geographiclib<https://PyPI.org/ project/geographiclib>} not installed or not found. @raise TypeError: If B{C{cs0}} is not L{CassiniSoldner}. @raise ValueError: Invalid B{C{h}}. @example: >>> cs = Css(448251, 5411932.0001) ''' self._cs0 = _CS0(cs0) self._easting = Easting(e, Error=CSSError) self._northing = Northing(n, Error=CSSError) if h: self._height = Height(h=h) if name: self.name = name @Property_RO def azi(self): '''Get the azimuth of easting direction (C{degrees}). ''' return self.reverse4.azimuth azimuth = azi @Property_RO def cs0(self): '''Get the projection (L{CassiniSoldner}). ''' return self._cs0 or Css._CS0 @Property_RO def easting(self): '''Get the easting (C{meter}). ''' return self._easting @Property_RO def height(self): '''Get the height (C{meter}). ''' return self._height @Property_RO def latlon(self): '''Get the lat- and longitude (L{LatLon2Tuple}). ''' r = self.reverse4 return LatLon2Tuple(r.lat, r.lon, name=self.name) @Property_RO def northing(self): '''Get the northing (C{meter}). ''' return self._northing @Property_RO def reverse4(self): '''Get the lat, lon, azimuth and reciprocal (L{LatLonAziRk4Tuple}). ''' return self.cs0.reverse4(self.easting, self.northing, name=self.name) @Property_RO def rk(self): '''Get the reciprocal of azimuthal northing scale (C{scalar}). ''' return self.reverse4.reciprocal reciprocal = rk def toLatLon(self, LatLon=None, height=None, **LatLon_kwds): '''Convert this L{Css} to an (ellipsoidal) geodetic point. @kwarg LatLon: Optional, ellipsoidal class to return the geodetic point (C{LatLon}) or C{None}. @kwarg height: Optional height for the point, overriding the default height (C{meter}). @kwarg LatLon_kwds: Optional, additional B{C{LatLon}} keyword arguments, ignored if C{B{LatLon} is None}. @return: The geodetic point (B{C{LatLon}}) or if B{C{LatLon}} is C{None}, a L{LatLon4Tuple}C{(lat, lon, height, datum)}. @raise TypeError: If B{C{LatLon}} or B{C{datum}} is not ellipsoidal or invalid B{C{height}} or B{C{LatLon_kwds}}. ''' if LatLon: _xsubclassof(_LLEB, LatLon=LatLon) lat, lon = self.latlon h = self.height if height is None else Height(height) return _LL4Tuple(lat, lon, h, self.cs0.datum, LatLon, LatLon_kwds, inst=self, name=self.name) def toRepr(self, prec=6, fmt=Fmt.SQUARE, sep=_COMMASPACE_, m=_m_, C=False): # PYCHOK expected '''Return a string representation of this L{Css} position. @kwarg prec: Optional number of decimals, unstripped (C{int}). @kwarg fmt: Optional, enclosing backets format (C{str}). @kwarg sep: Optional separator between name:values (C{str}). @kwarg m: Optional unit of the height, default meter (C{str}). @kwarg C: Optionally, include name of projection (C{bool}). @return: This position as C{"[E:meter, N:meter, H:m, name:'', C:Conic.Datum]"} (C{str}). ''' t, T = _fstrENH2(self, prec, m) if self.name: t += repr(self.name), T += _name_, if C: t += self.cs0.toRepr(prec=prec), T += _C_, return _xzipairs(T, t, sep=sep, fmt=fmt) def toStr(self, prec=6, sep=_SPACE_, m=_m_): # PYCHOK expected '''Return a string representation of this L{Css} position. @kwarg prec: Optional number of decimal, unstripped (C{int}). @kwarg sep: Optional separator to join (C{str}) or C{None} to return an unjoined C{tuple} of C{str}s. @kwarg m: Optional height units, default C{meter} (C{str}). @return: This position as C{"easting nothing"} C{str} in C{meter} plus C{" height"} and C{'m'} if height is non-zero (C{str}). ''' t, _ = _fstrENH2(self, prec, m) return t if sep is None else sep.join(t) class EasNorAziRk4Tuple(_NamedTuple): '''4-Tuple C{(easting, northing, azimuth, reciprocal)} for the Cassini-Soldner location with C{easting} and C{northing} in C{meters} and the C{azimuth} of easting direction and C{reciprocal} of azimuthal northing scale, both in C{degrees}. ''' _Names_ = (_easting_, _northing_, _azimuth_, _reciprocal_) _Units_ = ( Easting, Northing, Bearing, Scalar) class LatLonAziRk4Tuple(_NamedTuple): '''4-Tuple C{(lat, lon, azimuth, reciprocal)}, all in C{degrees} where C{azimuth} is the azimuth of easting direction and C{reciprocal} the reciprocal of azimuthal northing scale. ''' _Names_ = (_lat_, _lon_, _azimuth_, _reciprocal_) _Units_ = ( Lat_, Lon_, Bearing, Scalar) def toCss(latlon, cs0=None, height=None, Css=Css, name=NN): '''Convert an (ellipsoidal) geodetic point to a Cassini-Soldner location. @arg latlon: Ellipsoidal point (C{LatLon} or L{LatLon4Tuple}). @kwarg cs0: Optional, the Cassini-Soldner projection to use (L{CassiniSoldner}). @kwarg height: Optional height for the point, overriding the default height (C{meter}). @kwarg Css: Optional class to return the location (L{Css}) or C{None}. @kwarg name: Optional B{C{Css}} name (C{str}). @return: The Cassini-Soldner location (B{C{Css}}) or an L{EasNor3Tuple}C{(easting, northing, height)} if B{C{Css}} is C{None}. @raise CSSError: Ellipsoidal mismatch of B{C{latlon}} and B{C{cs0}}. @raise ImportError: Package U{geographiclib<https://PyPI.org/ project/geographiclib>} not installed or not found. @raise TypeError: If B{C{latlon}} is not ellipsoidal. ''' _xinstanceof(_LLEB, LatLon4Tuple, latlon=latlon) cs = _CS0(cs0) cs._datumatch(latlon) c = cs.forward4(latlon.lat, latlon.lon) h = latlon.height if height is None else Height(height) n = name or nameof(latlon) if Css is None: r = EasNor3Tuple(c.easting, c.northing, h, name=n) else: r = Css(c.easting, c.northing, h=h, cs0=cs, name=n) r._latlon = LatLon2Tuple(latlon.lat, latlon.lon, name=n) r._azi, r._rk = c.azimuth, c.reciprocal return r # **) MIT License # # Copyright (C) 2016-2022 -- 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.