rsgispy 0.0.1__tar.gz

rsgispy-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

rsgispy-0.0.1/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: rsgispy
+Version: 0.0.1
+Summary: A pure Python replacement for RSGISLib which is easier to install and maintain
+Author-email: Pete Bunting <petebunting@mac.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/remotesensinginfo/rsgispy
+Project-URL: Repository, https://github.com/remotesensinginfo/rsgispy
+Project-URL: Issues, https://github.com/remotesensinginfo/rsgispy/issues
+Keywords: remote sensing,GIS,raster,geospatial,earth observation,rsgislib
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: geopandas>=1.0
+Requires-Dist: matplotlib>=3.5
+Requires-Dist: matplotlib-scalebar>=0.8
+Requires-Dist: numpy>=1.20
+Requires-Dist: pymu-eval>=0.0.1
+Requires-Dist: pyproj>=3.4
+Requires-Dist: rasterio>=1.3
+Requires-Dist: shapely>=2.0
+Requires-Dist: tqdm>=4.60
+Provides-Extra: stats
+Requires-Dist: scikit-learn>=1.2; extra == "stats"
+Requires-Dist: scipy>=1.7; extra == "stats"
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0; extra == "test"
+Requires-Dist: pylint>=3.0; extra == "test"
+Requires-Dist: rsgispy[stats]; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: rsgispy[docs,stats,test]; extra == "dev"
+Dynamic: license-file
+
+# rsgispy
+A pure python replacement for RSGISLib which is easier to install and maintain

rsgispy-0.0.1/README.md

@@ -0,0 +1,2 @@
+# rsgispy
+A pure python replacement for RSGISLib which is easier to install and maintain

rsgispy-0.0.1/pyproject.toml

@@ -0,0 +1,85 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rsgispy"
+dynamic = ["version"]
+description = "A pure Python replacement for RSGISLib which is easier to install and maintain"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "Apache-2.0"}
+authors = [
+    {name = "Pete Bunting", email = "petebunting@mac.com"}
+]
+keywords = [
+    "remote sensing",
+    "GIS",
+    "raster",
+    "geospatial",
+    "earth observation",
+    "rsgislib",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering :: GIS",
+    "Topic :: Scientific/Engineering :: Image Processing",
+]
+dependencies = [
+    "geopandas>=1.0",
+    "matplotlib>=3.5",
+    "matplotlib-scalebar>=0.8",
+    "numpy>=1.20",
+    "pymu-eval>=0.0.1",
+    "pyproj>=3.4",
+    "rasterio>=1.3",
+    "shapely>=2.0",
+    "tqdm>=4.60",
+]
+
+[project.optional-dependencies]
+stats = [
+    "scikit-learn>=1.2",
+    "scipy>=1.7",
+]
+test = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "pylint>=3.0",
+    "rsgispy[stats]",
+]
+docs = [
+    "sphinx>=7.0",
+    "sphinx-rtd-theme>=2.0",
+]
+dev = [
+    "rsgispy[stats,test,docs]",
+]
+
+[project.urls]
+Homepage = "https://github.com/remotesensinginfo/rsgispy"
+Repository = "https://github.com/remotesensinginfo/rsgispy"
+Issues = "https://github.com/remotesensinginfo/rsgispy/issues"
+
+[tool.setuptools.dynamic]
+version = {attr = "rsgispy.__version__"}
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["rsgispy*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["."]

rsgispy-0.0.1/rsgispy/__init__.py

@@ -0,0 +1,254 @@
+"""
+rsgispy: Pure Python replacement for the RSGISLib library.
+Provides remote sensing and GIS software tools and utilities.
+
+Data Types for images:
+
+    * TYPE_UNDEFINED = 0
+    * TYPE_8INT = 1
+    * TYPE_16INT = 2
+    * TYPE_32INT = 3
+    * TYPE_64INT = 4
+    * TYPE_8UINT = 5
+    * TYPE_16UINT = 6
+    * TYPE_32UINT = 7
+    * TYPE_64UINT = 8
+    * TYPE_32FLOAT = 9
+    * TYPE_64FLOAT = 10
+"""
+
+from typing import Union
+import numpy as np
+from rasterio.enums import Resampling
+
+__version__ = "0.0.1"
+
+TYPE_UNDEFINED = 0
+TYPE_8INT = 1
+TYPE_16INT = 2
+TYPE_32INT = 3
+TYPE_64INT = 4
+TYPE_8UINT = 5
+TYPE_16UINT = 6
+TYPE_32UINT = 7
+TYPE_64UINT = 8
+TYPE_32FLOAT = 9
+TYPE_64FLOAT = 10
+
+INTERP_NEAREST_NEIGHBOUR = 0
+INTERP_BILINEAR = 1
+INTERP_CUBIC = 2
+INTERP_CUBICSPLINE = 3
+INTERP_LANCZOS = 4
+INTERP_AVERAGE = 5
+INTERP_MODE = 6
+INTERP_MIN = 7
+INTERP_MAX = 8
+INTERP_MEDIAN = 9
+INTERP_Q1 = 10
+INTERP_Q3 = 11
+INTERP_SUM = 12
+
+IMG_STRETCH_NONE = 0
+IMG_STRETCH_USER = 1
+IMG_STRETCH_LINEAR = 2
+IMG_STRETCH_STDEV = 3
+IMG_STRETCH_CUMULATIVE = 4
+
+_RSGIS_TO_RASTERIO_INTERP = {
+    INTERP_NEAREST_NEIGHBOUR: Resampling.nearest,
+    INTERP_BILINEAR: Resampling.bilinear,
+    INTERP_CUBIC: Resampling.cubic,
+    INTERP_CUBICSPLINE: Resampling.cubic_spline,
+    INTERP_LANCZOS: Resampling.lanczos,
+    INTERP_AVERAGE: Resampling.average,
+    INTERP_MODE: Resampling.mode,
+    INTERP_MIN: Resampling.min,
+    INTERP_MAX: Resampling.max,
+    INTERP_MEDIAN: Resampling.med,
+    INTERP_Q1: Resampling.q1,
+    INTERP_Q3: Resampling.q3,
+    INTERP_SUM: Resampling.sum,
+}
+
+_RSGIS_TO_RASTERIO_DTYPE = {
+    TYPE_8INT: "int8",
+    TYPE_16INT: "int16",
+    TYPE_32INT: "int32",
+    TYPE_64INT: "int64",
+    TYPE_8UINT: "uint8",
+    TYPE_16UINT: "uint16",
+    TYPE_32UINT: "uint32",
+    TYPE_64UINT: "uint64",
+    TYPE_32FLOAT: "float32",
+    TYPE_64FLOAT: "float64",
+}
+
+_RSGIS_TO_NUMPY_DTYPE = {
+    TYPE_8INT: np.int8,
+    TYPE_16INT: np.int16,
+    TYPE_32INT: np.int32,
+    TYPE_64INT: np.int64,
+    TYPE_8UINT: np.uint8,
+    TYPE_16UINT: np.uint16,
+    TYPE_32UINT: np.uint32,
+    TYPE_64UINT: np.uint64,
+    TYPE_32FLOAT: np.float32,
+    TYPE_64FLOAT: np.float64,
+}
+
+_RSGIS_TO_STR_DTYPE = {
+    TYPE_8INT: "8 bit INTEGER",
+    TYPE_16INT: "16 bit INTEGER",
+    TYPE_32INT: "32 bit INTEGER",
+    TYPE_64INT: "64 bit INTEGER",
+    TYPE_8UINT: "8 bit UNSIGNED INTEGER (BYTE)",
+    TYPE_16UINT: "16 bit UNSIGNED INTEGER",
+    TYPE_32UINT: "32 bit UNSIGNED INTEGER",
+    TYPE_64UINT: "64 bit UNSIGNED INTEGER",
+    TYPE_32FLOAT: "32 bit FLOAT",
+    TYPE_64FLOAT: "64 bit FLOAT",
+}
+
+_STR_TO_RSGIS_DTYPE = {
+    "int8": TYPE_8INT,
+    "int16": TYPE_16INT,
+    "int32": TYPE_32INT,
+    "int64": TYPE_64INT,
+    "byte": TYPE_8UINT,
+    "uint8": TYPE_8UINT,
+    "uint16": TYPE_16UINT,
+    "uint32": TYPE_32UINT,
+    "uint64": TYPE_64UINT,
+    "float32": TYPE_32FLOAT,
+    "float64": TYPE_64FLOAT,
+}
+
+
+class RSGISPyException(Exception):
+    """
+    A class representing an RSGISPy exception.
+    """
+
+    def __init__(self, value: str):
+        """
+        Init for the RSGISPyException class.
+        """
+        super().__init__(value)
+        self.value = value
+
+    def __str__(self) -> str:
+        """
+        Return a string representation of the exception.
+        """
+        return repr(self.value)
+
+
+def get_rsgis_datatype(gdal_type: str) -> int:
+    """
+    Convert from a GDAL/rasterio data type string to an RSGIS data type int.
+
+    :param gdal_type: Data type name string (e.g., 'float32', 'uint8', 'byte').
+    :return: RSGIS data type constant (e.g., rsgispy.TYPE_32FLOAT).
+    """
+    key = gdal_type.lower().strip()
+    if key not in _STR_TO_RSGIS_DTYPE:
+        raise RSGISPyException(
+            f"The data type '{gdal_type}' is unknown / not supported."
+        )
+    return _STR_TO_RSGIS_DTYPE[key]
+
+
+def get_rasterio_datatype(rsgislib_datatype: int) -> str:
+    """
+    Convert from an RSGIS data type int to a rasterio/GDAL dtype string.
+
+    :param rsgislib_datatype: RSGIS data type constant (e.g., rsgispy.TYPE_32FLOAT).
+    :return: Rasterio dtype string (e.g., 'float32').
+    """
+    if rsgislib_datatype not in _RSGIS_TO_RASTERIO_DTYPE:
+        raise RSGISPyException(
+            f"The data type '{rsgislib_datatype}' is unknown / not supported."
+        )
+    return _RSGIS_TO_RASTERIO_DTYPE[rsgislib_datatype]
+
+
+def get_numpy_datatype(rsgislib_datatype: int):
+    """
+    Convert from an RSGIS data type int to a NumPy dtype.
+
+    :param rsgislib_datatype: RSGIS data type constant (e.g., rsgispy.TYPE_32FLOAT).
+    :return: NumPy dtype class (e.g., numpy.float32).
+    """
+    if rsgislib_datatype not in _RSGIS_TO_NUMPY_DTYPE:
+        raise RSGISPyException("Data type was not recognised.")
+    return _RSGIS_TO_NUMPY_DTYPE[rsgislib_datatype]
+
+
+def get_rsgis_datatype_str(rsgislib_datatype: int) -> str:
+    """
+    Get a human-readable string representation of the RSGIS data type.
+
+    :param rsgislib_datatype: RSGIS data type constant.
+    :return: Human-readable string description.
+    """
+    if rsgislib_datatype not in _RSGIS_TO_STR_DTYPE:
+        raise RSGISPyException(
+            f"The data type '{rsgislib_datatype}' is unknown / not supported."
+        )
+    return _RSGIS_TO_STR_DTYPE[rsgislib_datatype]
+
+
+def get_rasterio_interp_type(
+    rsgis_interp_method: Union[int, Resampling],
+) -> Resampling:
+    """
+    Convert an ``rsgispy.INTERP_*`` (or ``rsgislib.INTERP_*``) constant to a
+    ``rasterio.enums.Resampling`` enum member.
+
+    :param rsgis_interp_method: Interpolation constant or ``Resampling`` enum.
+    :return: Corresponding ``rasterio.enums.Resampling`` value.
+    """
+    if isinstance(rsgis_interp_method, Resampling):
+        return rsgis_interp_method
+    if rsgis_interp_method not in _RSGIS_TO_RASTERIO_INTERP:
+        raise RSGISPyException(
+            "Interpolation method was not recognised or known."
+        )
+    return _RSGIS_TO_RASTERIO_INTERP[rsgis_interp_method]
+
+
+def is_notebook() -> bool:
+    """
+    Determine whether code is executing inside a Jupyter notebook environment.
+
+    :return: True if running within a Jupyter notebook or qtconsole, False otherwise.
+    """
+    try:
+        shell = get_ipython().__class__.__name__  # type: ignore[name-defined]
+        if shell == "ZMQInteractiveShell":
+            return True
+        return False
+    except NameError:
+        return False
+
+
+def get_tqdm():
+    """
+    Return the appropriate tqdm progress bar callable for the current environment
+    (Jupyter notebook widget when inside a notebook and ipywidgets is available,
+    or standard terminal tqdm otherwise).
+
+    :return: tqdm class/callable.
+    """
+    if is_notebook():
+        try:
+            import ipywidgets  # noqa: F401  # pylint: disable=unused-import,import-outside-toplevel
+            import tqdm.notebook  # pylint: disable=import-outside-toplevel
+
+            return tqdm.notebook.tqdm
+        except ImportError:
+            pass
+    import tqdm  # pylint: disable=import-outside-toplevel
+
+    return tqdm.tqdm