pygeodesy 24.3.24__py2.py3-none-any.whl

pygeodesy/deprecated/__init__.py

@@ -0,0 +1,61 @@
+
+# -*- coding: utf-8 -*-
+
+u'''DEPRECATED classes, constants, functions, interns, methods, etc. and all
+lazily imported.
+
+Kept for backward compatibility, including DEPRECATED modules C{pygeodesy.bases},
+C{pygeodesy.datum} and C{pygeodesy.nvector}.  Use either C{from pygeodesy import
+bases} or C{from pygeodesy.deprecated import bases}.  Likewise for C{datum} and
+C{nvector}.
+'''
+
+from pygeodesy.deprecated.bases import *  # PYCHOK not pygeodesy.__init__
+from pygeodesy.deprecated.datum import *  # PYCHOK not pygeodesy.__init__
+from pygeodesy.deprecated.nvector import *  # PYCHOK not pygeodesy.__init__
+
+from pygeodesy.deprecated.classes import *  # PYCHOK expected
+from pygeodesy.deprecated.consterns import *  # PYCHOK expected
+from pygeodesy.deprecated.functions import *  # PYCHOK expected
+
+from pygeodesy.lazily import _ALL_ATTRS, _ALL_DEPRECATED, _lazy_import_as, _unLazy0  # _lazy_import_star
+
+__all__ = (_ALL_DEPRECATED.deprecated_bases +
+           _ALL_DEPRECATED.deprecated_datum +
+           _ALL_DEPRECATED.deprecated_nvector +
+
+           _ALL_DEPRECATED.deprecated_classes +
+           _ALL_DEPRECATED.deprecated_consterns +
+           _ALL_DEPRECATED.deprecated_functions)
+__version__ = '24.02.08'
+
+if _unLazy0:
+    from pygeodesy.deprecated import bases, datum, nvector, rhumbBase, \
+                                     rhumbaux, rhumbsolve, rhumbx  # PYCHOK expected
+    __all__ += _ALL_ATTRS(_ALL_DEPRECATED.deprecated)  # DEPRECATED modules
+
+else:  # lazily import modules and exported attrs
+    __getattr__ = _lazy_import_as(__name__)
+#   __star__    = _lazy_import_star(__name__)
+
+# **) MIT License
+#
+# Copyright (C) 2018-2024 -- 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.

pygeodesy/deprecated/bases.py

@@ -0,0 +1,40 @@
+
+# -*- coding: utf-8 -*-
+
+u'''DEPRECATED on 2021.02.10, use (INTERNAL) module L{pygeodesy.latlonBase} instead.
+'''
+
+from pygeodesy.iters import points2  # PYCHOK exported
+from pygeodesy.latlonBase import LatLonBase as _LatLonBase
+from pygeodesy.lazily import _ALL_DEPRECATED
+
+__all__ = _ALL_DEPRECATED.deprecated_bases
+__version__ = '23.11.25'
+
+
+class LatLonHeightBase(_LatLonBase):  # PYCHOK no cover
+    ''''DEPRECATED on 2021.02.10, use (INTERNAL) class L{pygeodesy.latlonBase.LatLonBase}.'''
+    pass
+
+
+# **) MIT License
+#
+# Copyright (C) 2016-2024 -- 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.

pygeodesy/deprecated/classes.py

@@ -0,0 +1,262 @@
+
+# -*- coding: utf-8 -*-
+
+u'''DEPRECATED classes kept for backward compatibility.
+'''
+
+from pygeodesy.clipy import ClipCS4Tuple as _ClipCS4Tuple
+from pygeodesy.constants import NAN, _float
+from pygeodesy.interns import NN, _a12_, _area_, _band_, _convergence_, \
+                             _distance_, _gamma_, _i_, _lat_, _lon_, _ltp_
+from pygeodesy.deprecated.consterns import _Deprecated_Str
+from pygeodesy.karney import _GTuple, Rhumb8Tuple as _Rhumb8Tuple
+from pygeodesy.lazily import _ALL_DEPRECATED, _ALL_DOCS, _ALL_MODS as _MODS
+from pygeodesy.ltpTuples import Ned4Tuple as _Ned4Tuple
+# from pygeodesy.named import _NamedTuple  # from .namedTuples
+from pygeodesy.namedTuples import Forward4Tuple as _Forward4Tuple, \
+                                  Reverse4Tuple as _Reverse4Tuple, \
+                                  UtmUps5Tuple  as _UtmUps5Tuple,  _NamedTuple
+from pygeodesy.props import deprecated_class, deprecated_method
+from pygeodesy.resections import TriAngle5Tuple as _TriAngle5Tuple
+from pygeodesy.trf import TRFXform7Tuple as _TRFXform7Tuple
+from pygeodesy.units import Bearing, Int, Lat, Lon, Meter
+
+__all__ = _ALL_DEPRECATED.deprecated_classes
+__version__ = '24.02.02'
+
+
+class _Deprecated_NamedTuple(_NamedTuple):
+    '''DEPRECATED, C{_NamedTuple} base.
+    '''
+    def __new__(cls, *args, **kwds):
+        deprecated_class(cls)
+        return _NamedTuple.__new__(cls, *args, **kwds)
+
+
+def _reNames(names, old, *new):
+    # replace item C{old} with C{new} name
+    i = names.index(old)
+    return names[:i] + new + names[i + 1:]
+
+
+class ClipCS3Tuple(_Deprecated_NamedTuple):  # PYCHOK no cover
+    '''DEPRECATED, see I{DEPRECATED} function L{pygeodesy.deprecated.clipCS3}.'''
+    assert _ClipCS4Tuple._Names_.index(_i_) == 2
+    _Names_ = _reNames(_ClipCS4Tuple._Names_[:3], _i_, 'index')
+    _Units_ =          _ClipCS4Tuple._Units_[:3]
+
+
+class EasNorExact4Tuple(_Deprecated_NamedTuple):
+    '''DEPRECATED, use class L{Forward4Tuple}, item C{gamma} for C{convergence}.'''
+    _Names_ = _reNames(_Forward4Tuple._Names_, _gamma_, _convergence_)
+    _Units_ =          _Forward4Tuple._Units_
+
+
+def EcefCartesian(*args, **kwds):
+    '''DEPRECATED, use class L{LocalCartesian}.'''
+    Ltp = _MODS.ltp.Ltp
+
+    class EcefCartesian_(Ltp):
+        '''DEPRECATED, use class L{LocalCartesian} or L{Ltp}.
+
+           @note: This class is named I{incorrectly}, since it provides conversion to
+                  and from I{local} cartesian coordinates in a I{local tangent plane}
+                  and I{not geocentric} (ECEF) ones, as the name would suggest.
+        '''
+        def __init__(self, latlonh0=0, lon0=0, height0=0, ecef=None, name=NN):
+            deprecated_class(self.__class__)
+            Ltp.__init__(self, latlonh0=latlonh0, lon0=lon0, height0=height0, ecef=ecef, name=name)
+
+        @deprecated_method
+        def forward(self, latlonh, lon=None, height=0, M=False, name=NN):
+            '''DEPRECATED, use method L{LocalCartesian.forward} or L{Ltp.forward}.
+
+               @return: I{Incorrectly}, an L{Ecef9Tuple}C{(x, y, z, lat, lon, height, C,
+                        M, datum)} with I{local} C{(x, y, z)} coordinates for the given
+                        I{geodetic} ones C{(lat, lon, height)}, case C{C=0} always,
+                        optionally I{concatenated} L{EcefMatrix} C{M} and C{datum}.
+            '''
+            t = Ltp.forward(self, latlonh, lon=lon, height=height, M=M, name=name)
+            return _MODS.ecef.Ecef9Tuple(t.x, t.y, t.z, t.lat, t.lon, t.height,
+                                                        0, t.M, t.ecef.datum,
+                                                        name=t.name or self.name)
+
+        @deprecated_method
+        def reverse(self, xyz, y=None, z=None, M=False, name=NN):
+            '''DEPRECATED, use method L{LocalCartesian.reverse} or L{Ltp.reverse}.
+
+               @return: I{Incorrectly}, an L{Ecef9Tuple}C{(x, y, z, lat, lon, height, C,
+                        M, datum)} with I{geodetic} coordinates C{(lat, lon, height)} for
+                        the given I{local} ones C{(x, y, z)}, case C{C}, optionally
+                        I{concatenated} L{EcefMatrix} C{M} and C{datum}.
+            '''
+            t = Ltp.reverse(self, xyz, y=y, z=z, M=M, name=name)
+            return _MODS.ecef.Ecef9Tuple(t.x, t.y, t.z, t.lat, t.lon, t.height,
+                                                        t.ecef.C, t.M, t.ecef.datum,
+                                                        name=t.name or self.name)
+
+    return EcefCartesian_(*args, **kwds)
+
+
+def HeightIDW(knots, **kwds):  # PYCHOK no cover
+    '''DEPRECATED, use class L{HeightIDWeuclidean}.'''
+    HeightIDWeuclidean = _MODS.heights.HeightIDWeuclidean
+
+    class HeightIDW(HeightIDWeuclidean):
+        '''DEPRECATED, use class L{HeightIDWeuclidean}.'''
+        def __init__(self, knots, adjust=True, beta=2, name=NN):
+            deprecated_class(self.__class__)
+            HeightIDWeuclidean.__init__(self, knots, adjust=adjust, beta=beta, name=name)
+
+    return HeightIDW(knots, **kwds)
+
+
+def HeightIDW2(knots, **kwds):  # PYCHOK no cover
+    '''DEPRECATED, use class L{HeightIDWequirectangular}.'''
+    HeightIDWequirectangular = _MODS.heights.HeightIDWequirectangular
+
+    class HeightIDW2(HeightIDWequirectangular):
+        '''DEPRECATED, use class L{HeightIDWequirectangular}.'''
+        def __init__(self, knots, adjust=True, wrap=False, name=NN):
+            deprecated_class(self.__class__)
+            HeightIDWequirectangular.__init__(self, knots, adjust=adjust, wrap=wrap, name=name)
+
+    return HeightIDW2(knots, **kwds)
+
+
+def HeightIDW3(knots, **kwds):  # PYCHOK no cover
+    '''DEPRECATED, use class L{HeightIDWhaversine}.'''
+    HeightIDWhaversine = _MODS.heights.HeightIDWhaversine
+
+    class HeightIDW3(HeightIDWhaversine):
+        '''DEPRECATED, use class L{HeightIDWhaversine}.
+        '''
+        def __init__(self, knots, beta=2, wrap=False, name=NN):
+            deprecated_class(self.__class__)
+            HeightIDWhaversine.__init__(self, knots, beta=beta, wrap=wrap, name=name)
+
+    return HeightIDW3(knots, **kwds)
+
+
+class LatLonExact4Tuple(_Deprecated_NamedTuple):
+    '''DEPRECATED, use class L{Reverse4Tuple}, item C{gamma} for C{convergence}.'''
+    _Names_ = _reNames(_Reverse4Tuple._Names_, _gamma_, _convergence_)
+    _Units_ =          _Reverse4Tuple._Units_
+
+
+class NearestOn4Tuple(_Deprecated_NamedTuple):  # PYCHOK no cover
+    '''DEPRECATED on 2023.10.10, see methods L{RhumbLine.nearestOn4} and L{RhumbLineAux.nearestOn4}.'''
+    _Names_ = (_lat_, _lon_, _distance_, 'normal')  # s12, azi02
+    _Units_ = ( Lat,   Lon,   Meter,      Bearing)
+
+
+class Ned3Tuple(_Deprecated_NamedTuple):  # was in .ellipsoidalNvector
+    '''DEPRECATED, use class L{Ned4Tuple}, ignoring item C{ltp}.'''
+    assert _Ned4Tuple._Names_.index(_ltp_) == 3
+    _Names_ = _Ned4Tuple._Names_[:3]
+    _Units_ = _Ned4Tuple._Units_[:3]
+
+
+def RefFrameError(*args, **kwds):  # PYCHOK no cover
+    '''DEPRECATED, use class L{TRFError}.'''
+    TRFError = _MODS.errors.TRFError
+
+    class RefFrameError(TRFError):
+        '''DEPRECATED, use class L{TRFError}.
+        '''
+        def __init__(self, *name_value, **txt_name_values):
+            deprecated_class(self.__class__)
+            TRFError.__init__(self, *name_value, **txt_name_values)
+
+    return RefFrameError(*args, **kwds)
+
+
+class Rhumb7Tuple(_Deprecated_NamedTuple):
+    '''DEPRECATED, use class L{Rhumb8Tuple}, ignoring item C{a12}.'''
+    assert _Rhumb8Tuple._Names_.index(_a12_) == 7
+    _Names_ = _Rhumb8Tuple._Names_[:7]
+    _Units_ = _Rhumb8Tuple._Units_[:7]
+
+    @deprecated_method
+    def toDirect9Tuple(self, **kwds):
+        return self.toRhumb8Tuple().toDirect9Tuple(self, **kwds)
+
+    @deprecated_method
+    def toGDict(self, **kwds):
+        return self.toRhumb8Tuple().toGDict(**kwds)
+
+    @deprecated_method
+    def toInverse10Tuple(self, **kwds):
+        return self.toRhumb8Tuple().toInverse10Tuple(self, **kwds)
+
+    @deprecated_method
+    def toRhumb8Tuple(self, dflt=NAN):
+        return _Rhumb8Tuple(self + (dflt,), name=self.name)
+
+    def _to7Tuple(self):
+        '''(INTERNAL) see L{Rhumb8Tuple._to7Tuple}.
+        '''
+        return self
+
+
+class RhumbOrder2Tuple(_Deprecated_NamedTuple, _GTuple):
+    '''DEPRECATED, see deprecated method L{Rhumb.orders}.'''
+    # 2-Tuple C{(RAorder, TMorder)} with a I{Rhumb Area} and
+    # I{Transverse Mercator} order, both C{int}.
+    _Names_ = ('RAorder', 'TMorder')
+    _Units_ = ( Int,       Int)
+
+
+class Transform7Tuple(_Deprecated_NamedTuple):  # PYCHOK no cover
+    '''DEPRECATED on 2024.02.02, use class L{TRFXform7Tuple}, I{without} keyword arguments.'''
+    _Names_ = _TRFXform7Tuple._Names_
+    _Units_ = _TRFXform7Tuple._Units_
+
+    def __new__(cls, tx=0, ty=0, tz=0, s=0,
+                     sx=0, sy=0, sz=0, name=NN):
+        t = map(_float, (tx, ty, tz, s, sx, sy, sz))
+        return _Deprecated_NamedTuple.__new__(cls, *t, name=name)
+
+Helmert7Tuple = Transform7Tuple  # PYCHOK likewise
+
+
+class TriAngle4Tuple(_Deprecated_NamedTuple):
+    '''DEPRECATED on 2023.09.14, use class L{TriAngle5Tuple}, ignoring item C{area}.'''
+    assert _TriAngle5Tuple._Names_.index(_area_) == 4
+    _Names_ = _TriAngle5Tuple._Names_[:4]
+    _Units_ = _TriAngle5Tuple._Units_[:4]
+
+
+class UtmUps4Tuple(_Deprecated_NamedTuple):  # PYCHOK no cover
+    '''DEPRECATED and OBSOLETE, expect a L{UtmUps5Tuple} from method C{pygeodesy.Mgrs.toUtm(utm=None)}.
+
+       4-Tuple C{(zone, hemipole, easting, northing)} with as C{zone} B{C{str}} and no C{band}.
+    '''
+    assert _UtmUps5Tuple._Names_.index(_band_) == 4
+    _Names_ =                      _UtmUps5Tuple._Names_[ :4]  # band
+    _Units_ = (_Deprecated_Str,) + _UtmUps5Tuple._Units_[1:4]
+
+
+__all__ += _ALL_DOCS(_Deprecated_NamedTuple)
+
+# **) MIT License
+#
+# Copyright (C) 2018-2024 -- 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.

pygeodesy/deprecated/consterns.py

@@ -0,0 +1,54 @@
+
+# -*- coding: utf-8 -*-
+
+u'''DEPRECATED constants and interns kept for backward compatibility.
+'''
+
+from pygeodesy.constants import EPS_2, MANT_DIG, _1_0
+from pygeodesy.lazily import _ALL_DEPRECATED
+from pygeodesy.units import Float, Int, Str
+
+__all__ = _ALL_DEPRECATED.deprecated_consterns
+__version__ = '23.11.24'
+
+
+class _Deprecated_Float(Float):
+    '''DEPRECATED on 2023.09.12, don't use.'''
+    pass
+
+
+class _Deprecated_Int(Int):
+    '''DEPRECATED on 2023.09.12, don't use.'''
+    pass
+
+
+class _Deprecated_Str(Str):
+    '''DEPRECATED on 2023.09.12, don't use.'''
+    pass
+
+
+EPS1_2 = _Deprecated_Float(EPS1_2=_1_0 - EPS_2)
+MANTIS = _Deprecated_Int(MANTIS=MANT_DIG)
+OK     = _Deprecated_Str(OK='OK')
+
+# **) MIT License
+#
+# Copyright (C) 2018-2024 -- 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.

pygeodesy/deprecated/datum.py

@@ -0,0 +1,40 @@
+
+# -*- coding: utf-8 -*-
+
+u'''DEPRECATED on 2022.09.12, use module L{pygeodesy.datums} or L{pygeodesy.ellipsoids} instead.
+'''
+
+# XXX only the items previously public
+from pygeodesy.constants import R_M, R_MA, R_MB, R_KM, R_NM, R_SM, R_FM, R_VM
+from pygeodesy.datums import Datum, Datums, Transform, Transforms
+from pygeodesy.ellipsoids import Ellipsoid, Ellipsoids, Curvature2Tuple
+from pygeodesy.lazily import _ALL_DEPRECATED, _ALL_OTHER
+
+__all__ = _ALL_DEPRECATED.deprecated_datum
+__version__ = '23.11.26'
+
+assert _ALL_OTHER(Curvature2Tuple, Datum,  Ellipsoid,  Transform) + \
+            tuple(_.name for _ in (Datums, Ellipsoids, Transforms,
+                    R_M, R_MA, R_MB, R_KM, R_NM, R_SM, R_FM, R_VM)) == __all__
+
+# **) MIT License
+#
+# Copyright (C) 2016-2024 -- 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.