kuva-reader 1.1.1__tar.gz → 1.1.2__tar.gz

kuva_reader-1.1.2/.gitignore

@@ -0,0 +1,134 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+*.ipynb
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Torch stuff
+lightning_logs/
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# VSCode
+.vscode
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# Direnv stuff
+.direnv/
+.envrc
+
+# Poetry
+# poetry.lock
+
+# Supervisord
+supervisord.log
+supervisord.pid
+
+# Debug folders
+_debug/
+
+# Kuva data
+*.tif
+*.tiff
+*.npy
+hyperfield*.json
+
+# Do not ignore Kuva files in the test_data directory
+!kuva-reader/tests/test_data/**

{kuva_reader-1.1.1 → kuva_reader-1.1.2}/PKG-INFO

@@ -1,22 +1,16 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: kuva-reader
-Version: 1.1.1
+Version: 1.1.2
 Summary: Manipulate the Kuva Space image and metadata formats
-License: MIT
-Author: Guillem Ballesteros
-Author-email: guillem@kuvaspace.com
-Requires-Python: >=3.10,<=3.13
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: kuva-geometry (>=1.0.1,<2.0.0)
-Requires-Dist: kuva-metadata (>=1.1.1,<2.0.0)
-Requires-Dist: numpy (>=1.26.4,<2.0.0)
-Requires-Dist: numpy-quaternion (>=2022.4.4,<2023.0.0)
-Requires-Dist: pint (>=0.22,<0.23)
-Requires-Dist: rasterio (>=1.4.1,<2.0.0)
+Author-email: Guillem Ballesteros <guillem@kuvaspace.com>, Lennert Antson <lennert.antson@kuvaspace.com>, Arthur Vandenhoeke <arthur.vandenhoeke@kuvaspace.com>, Olli Eloranta <olli.eloranta@kuvaspace.com>
+License-Expression: MIT
+Requires-Python: <=3.13,>=3.10
+Requires-Dist: kuva-geometry<2.0.0,>=1.0.1
+Requires-Dist: kuva-metadata<2.0.0,>=1.1.1
+Requires-Dist: numpy-quaternion>=2023.4.4
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: pint<1.0.0,>=0.22
+Requires-Dist: rasterio<2,>=1.4.3
 Description-Content-Type: text/markdown
 
 <div align="center">
@@ -128,4 +122,3 @@ The `kuva-reader` project software is under the [MIT license](https://github.com
 # Status of unit tests
 
 [![Unit tests for kuva-reader](https://github.com/KuvaSpace/kuva-data-processing/actions/workflows/test-kuva-reader.yml/badge.svg)](https://github.com/KuvaSpace/kuva-data-processing/actions/workflows/test-kuva-reader.yml)
-

{kuva_reader-1.1.1 → kuva_reader-1.1.2}/kuva_reader/__init__.py

@@ -22,7 +22,7 @@ Dependencies
   visualization.
 """
 
-__version__ = "0.1.0"
+__version__ = "1.1.2"
 
 from .reader.image import (
     image_footprint,

{kuva_reader-1.1.1 → kuva_reader-1.1.2}/kuva_reader/reader/level0.py

@@ -61,7 +61,7 @@ class Level0Product(ProductBase[MetadataLevel0]):
     ) -> None:
         super().__init__(image_path, metadata, target_ureg)
 
-        self.images = {
+        self._images = {
             camera: cast(
                 rio.DatasetReader,
                 rio.open(
@@ -97,6 +97,12 @@ class Level0Product(ProductBase[MetadataLevel0]):
         """Return the datarray for the chosen camera."""
         return self.images[camera]
 
+    @property
+    def images(self) -> dict[str, rio.DatasetReader]:
+        if self._images is None:
+            raise RuntimeError("Images has been released.")
+        return self._images
+
     def keys(self) -> list[str]:
         """Easy access to the camera keys."""
         return list(self.images.keys())
@@ -230,11 +236,14 @@ class Level0Product(ProductBase[MetadataLevel0]):
         """Explicitely closes the Rasterio DatasetReaders and releases the memory of
         the `images` variable.
         """
-        for k in self.images.keys():
-            self.images[k].close()
-
-        del self.images
-        self.images = None
+        if self._images is not None:
+            for k in self._images.keys():
+                self._images[k].close()
+
+            del self._images
+            # We know that images are not None as long as somebody doesn't call
+            # this function beforehand....
+            self._images = None
 
 
 def generate_level_0_metafile():

{kuva_reader-1.1.1 → kuva_reader-1.1.2}/kuva_reader/reader/level1.py

@@ -50,7 +50,7 @@ class Level1ABProduct(ProductBase[MetadataLevel1AB]):
     ) -> None:
         super().__init__(image_path, metadata, target_ureg)
 
-        self.image = cast(
+        self._image = cast(
             rio.DatasetReader,
             rio.open(self.image_path / "L1B.tif"),
         )
@@ -73,6 +73,12 @@ class Level1ABProduct(ProductBase[MetadataLevel1AB]):
         else:
             return f"{self.__class__.__name__} loaded from '{self.image_path}'"
 
+    @property
+    def image(self) -> rio.DatasetReader:
+        if self._image is None:
+            raise RuntimeError("Images has been released.")
+        return self._image
+
     def footprint(self, crs="") -> Polygon:
         """The product footprint as a Shapely polygon."""
         return image_footprint(self.image, crs)
@@ -130,8 +136,10 @@ class Level1ABProduct(ProductBase[MetadataLevel1AB]):
         """Explicitely closes the Rasterio DatasetReader and releases the memory of
         the `image` variable.
         """
-        del self.image
-        self.image = None
+        if self._image is not None:
+            self._image.close()
+            del self._image
+            self._image = None
 
 
 class Level1CProduct(ProductBase[MetadataLevel1C]):
@@ -170,7 +178,7 @@ class Level1CProduct(ProductBase[MetadataLevel1C]):
     ) -> None:
         super().__init__(image_path, metadata, target_ureg)
 
-        self.image = cast(
+        self._image = cast(
             rio.DatasetReader,
             rio.open(self.image_path / "L1C.tif"),
         )
@@ -193,6 +201,12 @@ class Level1CProduct(ProductBase[MetadataLevel1C]):
         else:
             return f"{self.__class__.__name__} loaded from '{self.image_path}'"
 
+    @property
+    def image(self) -> rio.DatasetReader:
+        if self._image is None:
+            raise RuntimeError("Images has been released.")
+        return self._image
+
     def footprint(self, crs="") -> Polygon:
         """The product footprint as a Shapely polygon."""
         return image_footprint(self.image, crs)
@@ -231,9 +245,10 @@ class Level1CProduct(ProductBase[MetadataLevel1C]):
         """Explicitely closes the Rasterio DatasetReader and releases the memory of
         the `image` variable.
         """
-        self.image.close()
-        del self.image
-        self.image = None
+        if self._image is not None:
+            self._image.close()
+            del self._image
+            self._image = None
 
 
 def generate_level_1_metafile():

{kuva_reader-1.1.1 → kuva_reader-1.1.2}/kuva_reader/reader/product_base.py

@@ -35,7 +35,7 @@ class ProductBase(Generic[TMetadata], metaclass=ABCMeta):
     def __init__(
         self,
         image_path: Path,
-        metadata: MetadataBase | None = None,
+        metadata: TMetadata | None = None,
         target_ureg: UnitRegistry | None = None,
     ):
         self.image_path = Path(image_path)

{kuva_reader-1.1.1 → kuva_reader-1.1.2}/pyproject.toml

@@ -1,35 +1,43 @@
 [build-system]
-requires = [ "poetry-core>=1.0.0",]
-build-backend = "poetry.core.masonry.api"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
-[tool.poetry]
+[project]
 name = "kuva-reader"
-version = "1.1.1"
+version = "1.1.2"
 description = "Manipulate the Kuva Space image and metadata formats"
-authors = ["Guillem Ballesteros <guillem@kuvaspace.com>" , "Lennert Antson <lennert.antson@kuvaspace.com>", "Arthur Vandenhoeke <arthur.vandenhoeke@kuvaspace.com>", "Olli Eloranta <olli.eloranta@kuvaspace.com>"]
+authors = [
+  { name = "Guillem Ballesteros", email = "guillem@kuvaspace.com" },
+  { name = "Lennert Antson", email = "lennert.antson@kuvaspace.com" },
+  { name = "Arthur Vandenhoeke", email = "arthur.vandenhoeke@kuvaspace.com" },
+  { name = "Olli Eloranta", email = "olli.eloranta@kuvaspace.com" },
+]
 readme = "README.md"
 license = "MIT"
+requires-python = ">=3.10, <=3.13"
+dependencies = [
+  "numpy>=1.26.4",
+  "numpy-quaternion>=2023.4.4",
+  "pint >=0.22, <1.0.0",
+  "rasterio>=1.4.3,<2",
+  "kuva-geometry>=1.0.1,<2.0.0",
+  "kuva-metadata>=1.1.1,<2.0.0"
+]
+scripts.make-l0-meta = "kuva_reader.reader.level0:generate_level_0_metafile"
+scripts.make-l1-meta = "kuva_reader.reader.level1:generate_level_1_metafile"
+
+[dependency-groups]
+dev = [
+  "pyright>=1.1.403",
+  "pytest>=7.4.2,<8",
+  "ruff>=0.12.4",
+]
 
 [tool.ruff]
 target-version = "py310"
 line-length = 88
 dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
 
-[tool.mypy]
-ignore_missing_imports = true
-
-[tool.poetry.scripts]
-make-l0-meta = "kuva_reader.reader.level0:generate_level_0_metafile"
-make-l1-meta = "kuva_reader.reader.level1:generate_level_1_metafile"
-
-[tool.poetry.dependencies]
-python = ">=3.10,<=3.13"
-numpy = "^1.26.4"
-numpy-quaternion = "^2022.4.4"
-pint = "^0.22"
-rasterio = "^1.4.1"
-kuva-geometry = "^1.0.1"
-kuva-metadata = "^1.1.1"
 
 [tool.ruff.lint]
 select = [ "E", "F", "A", "DTZ", "NPY", "I", "ISC", "B003", "B004", "B015", "PTH", "D100", "D101", "D102", "D103", "D104", "D105", "D200", "W191", "W291", "W293", "N801", "N804", "N805", "T100", "S105", "S106", "S108", "S604", "S602", "S609", "UP003", "UP005", "UP006", "UP007", "UP008", "UP032", "UP035", "RUF001", "RUF200", "RUF013", "C901", "COM818", "RSE102", "EM101",]
@@ -44,7 +52,7 @@ convention = "numpy"
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = [ "F401", "D104", "E402",]
 
-[tool.poetry.group.dev.dependencies]
-mypy = "^1.2.0"
-pytest = "^7.4.2"
-ruff = "^0.1.1"
+# Uncomment during development
+# [tool.uv.sources]
+# kuva-geometry = { path = "../kuva-geometry" }
+# kuva-metadata = { path = "../kuva-metadata" }

kuva_reader-1.1.2/tests/test_reader.py

@@ -0,0 +1,74 @@
+"""Tests for reading of actual Hyperfield products.
+
+NOTE: To limit data size, the test data used in the kuva-reader tests have been cropped,
+and most of the bands have been removed. The original images are from a normal
+acquisition."""
+
+from pathlib import Path
+
+import pytest
+
+from kuva_reader import Level1CProduct, Level2AProduct, read_product
+
+TEST_DATA_ROOT = Path(__file__).parent / "test_data"
+L1C_PATH = TEST_DATA_ROOT / "hyperfield1a_L1C_20250310T142413"
+L2A_PATH = TEST_DATA_ROOT / "hyperfield1a_L2A_20250310T142413"
+
+
+@pytest.fixture
+def l1c_product() -> Level1CProduct:
+    """Fetch test L1C product.
+
+    NOTE: This is a cropped version of a Hyperfield-1A L1C cube with few bands (5)
+    """
+    return Level1CProduct(L1C_PATH)
+
+
+@pytest.fixture
+def l2a_product() -> Level2AProduct:
+    """Fetch test L2A product.
+
+    NOTE: This is a cropped version of a Hyperfield-1A L2A cube with few bands (5)
+    """
+    return Level2AProduct(L2A_PATH)
+
+
+def test_product_reader():
+    """Read the correct products with product reader function"""
+    with pytest.raises(ValueError):
+        read_product(L2A_PATH.parent)
+
+    product = read_product(L2A_PATH)
+    assert product.__class__ == Level2AProduct
+
+
+def test_read_l1c(l1c_product: Level1CProduct):
+    """Product reading was successful based on image, metadata and tags"""
+    # Check that image was loaded with correct number of bands
+    assert l1c_product.image.read().shape[0] == 5
+    # Check that metadata exists and has same shape as image
+    assert len(l1c_product.metadata.image.bands) == 5
+    # Check that tags exist
+    assert l1c_product.data_tags.get("AREA_OR_POINT") is not None
+
+
+def test_read_l2a(l2a_product: Level2AProduct):
+    """Product reading was successful based on image, metadata and tags"""
+    # Check that image was loaded with correct number of bands
+    assert l2a_product.image.read().shape[0] == 5
+    # Check that metadata exists and has same shape as image
+    assert len(l2a_product.metadata.image.bands) == 5
+    # Check that tags exist
+    assert l2a_product.data_tags.get("AREA_OR_POINT") is not None
+
+
+def test_read_bad_pixel_mask_l1c(l1c_product: Level1CProduct):
+    """Bad pixel mask is correctly loaded and is same shape as product"""
+    bad_pixel_mask = l1c_product.get_bad_pixel_mask().read()
+    assert bad_pixel_mask.shape[1:] == l1c_product.image.shape
+
+
+def test_read_bad_pixel_mask_l2a(l2a_product: Level2AProduct):
+    """Bad pixel mask is correctly loaded and is same shape as product"""
+    bad_pixel_mask = l2a_product.get_bad_pixel_mask().read()
+    assert bad_pixel_mask.shape[1:] == l2a_product.image.shape