kuva-reader 1.0.3__py3-none-any.whl → 1.0.4__py3-none-any.whl

kuva_reader/__init__.py

@@ -28,6 +28,7 @@ from .reader.image import (
     image_to_dtype_range,
     image_to_original_range,
     image_to_uint16_range,
+    image_footprint,
 )
 from .reader.level0 import Level0Product
 from .reader.level1 import Level1ABProduct, Level1CProduct
@@ -42,5 +43,6 @@ __all__ = [
     "image_to_dtype_range",
     "image_to_original_range",
     "image_to_uint16_range",
+    "image_footprint",
     "read_product",
 ]

kuva_reader/reader/image.py

@@ -4,11 +4,38 @@ from typing import cast, overload
 
 import numpy as np
 import xarray
+from shapely.geometry import box
+from pyproj import Transformer
+from shapely import Polygon
 
 # Helper type for image processing purposes. The same operations work both for EO
 # DataArrays and Numpy arrays.
 ImageArray_ = np.ndarray | xarray.DataArray
 
+def image_footprint(image: xarray.DataArray, crs: str = "") -> Polygon:
+    """Return a product footprint as a shapely polygon
+
+    Parameters
+    ----------
+    image
+        The product image
+    crs, optional
+        CRS to convert to, by default "", keeping the image's CRS
+
+    Returns
+    -------
+        A shapely polygon footprint
+    """
+    if crs:
+        transformer = Transformer.from_crs(image.rio.crs, crs, always_xy=True)
+        bounds = image.rio.bounds()
+        minx, miny = transformer.transform(bounds[0], bounds[1])
+        maxx, maxy = transformer.transform(bounds[2], bounds[3])
+        footprint = box(minx, miny, maxx, maxy)
+    else:
+        footprint = box(*image.rio.bounds())
+    return footprint
+
 
 @overload
 def image_to_dtype_range(

kuva_reader/reader/level0.py

@@ -6,8 +6,9 @@ import rioxarray as rx
 import xarray
 from kuva_metadata import MetadataLevel0
 from pint import UnitRegistry
+from shapely import Polygon
 
-from kuva_reader import image_to_dtype_range, image_to_original_range
+from kuva_reader import image_to_dtype_range, image_to_original_range, image_footprint
 
 from .product_base import ProductBase
 
@@ -80,6 +81,7 @@ class Level0Product(ProductBase[MetadataLevel0]):
             )
             for camera, cube in self.metadata.image.data_cubes.items()  # type: ignore
         }
+        self.crs = self.images[list(self.images.keys())[0]].rio.crs
 
         # Read tags for images and denormalize / renormalize if needed
         self.data_tags = {camera: img.attrs for camera, img in self.images.items()}
@@ -106,9 +108,9 @@ class Level0Product(ProductBase[MetadataLevel0]):
         if self.images is not None and len(self.images):
             return (
                 f"{self.__class__.__name__}"
-                f"with {len(self.images)} frames of shape {self.images[0].shape} "
-                f"and CRS '{self.images[0].rio.crs}'. "
-                f"Loaded from: '{self.image_path}'."
+                f"with VIS shape {self.images['vis'].shape} "
+                f"and NIR shape {self.images['nir'].shape} "
+                f"(CRS '{self.crs}'). Loaded from: '{self.image_path}'."
             )
         else:
             return f"{self.__class__.__name__} loaded from '{self.image_path}'."
@@ -121,6 +123,10 @@ class Level0Product(ProductBase[MetadataLevel0]):
         """Easy access to the camera keys."""
         return list(self.images.keys())
 
+    def footprint(self, crs="") -> Polygon:
+        """The product footprint as a Shapely polygon."""
+        return image_footprint(self.images["vis"], crs)
+
     def _get_data_from_sidecar(
         self, sidecar_path: Path, target_ureg: UnitRegistry | None = None
     ) -> MetadataLevel0:

kuva_reader/reader/level1.py

@@ -3,8 +3,10 @@ from typing import cast
 
 import rioxarray as rx
 import xarray
+from kuva_reader import image_footprint
 from kuva_metadata import MetadataLevel1AB, MetadataLevel1C
 from pint import UnitRegistry
+from shapely import Polygon
 from xarray import Dataset
 
 from .product_base import ProductBase
@@ -56,6 +58,25 @@ class Level1ABProduct(ProductBase[MetadataLevel1AB]):
             rx.open_rasterio(self.image_path / "L1B.tif"),
         )
         self.data_tags = self.image.attrs
+        self.wavelengths = [
+            b.wavelength.to("nm").magnitude for b in self.metadata.image.bands
+        ]
+        self.crs = self.image.rio.crs
+
+    def __repr__(self):
+        """Pretty printing of the object with the most important info"""
+        if self.image is not None:
+            return (
+                f"{self.__class__.__name__} with shape {self.image.shape} "
+                f"and wavelengths {self.wavelengths} (CRS: '{self.crs}'). "
+                f"Loaded from: '{self.image_path}'."
+            )
+        else:
+            return f"{self.__class__.__name__} loaded from '{self.image_path}'"
+
+    def footprint(self, crs="") -> Polygon:
+        """The product footprint as a Shapely polygon."""
+        return image_footprint(self.image, crs)
 
     def _get_data_from_sidecar(
         self, sidecar_path: Path, target_ureg: UnitRegistry | None = None
@@ -163,18 +184,23 @@ class Level1CProduct(ProductBase[MetadataLevel1C]):
         self.wavelengths = [
             b.wavelength.to("nm").magnitude for b in self.metadata.image.bands
         ]
+        self.crs = self.image.rio.crs
 
     def __repr__(self):
         """Pretty printing of the object with the most important info"""
         if self.image is not None:
             return (
                 f"{self.__class__.__name__} with shape {self.image.shape} "
-                f"and wavelengths {self.wavelengths} (CRS: '{self.image.rio.crs}'). "
+                f"and wavelengths {self.wavelengths} (CRS: '{self.crs}'). "
                 f"Loaded from: '{self.image_path}'."
             )
         else:
             return f"{self.__class__.__name__} loaded from '{self.image_path}'"
 
+    def footprint(self, crs="") -> Polygon:
+        """The product footprint as a Shapely polygon."""
+        return image_footprint(self.image, crs)
+
     def _get_data_from_sidecar(
         self, sidecar_path: Path, target_ureg: UnitRegistry | None = None
     ) -> MetadataLevel1C:

kuva_reader/reader/level2.py

@@ -2,8 +2,10 @@ from pathlib import Path
 from typing import cast
 
 import rioxarray as rx
+from kuva_reader import image_footprint
 from kuva_metadata import MetadataLevel2A
 from pint import UnitRegistry
+from shapely import Polygon
 from xarray import Dataset
 
 from .product_base import ProductBase
@@ -55,18 +57,23 @@ class Level2AProduct(ProductBase[MetadataLevel2A]):
         self.wavelengths = [
             b.wavelength.to("nm").magnitude for b in self.metadata.image.bands
         ]
+        self.crs = self.image.rio.crs
 
     def __repr__(self):
         """Pretty printing of the object with the most important info"""
         if self.image is not None:
             return (
                 f"{self.__class__.__name__} with shape {self.image.shape} "
-                f"and wavelengths {self.wavelengths} (CRS: '{self.image.rio.crs}'). "
+                f"and wavelengths {self.wavelengths} (CRS: '{self.crs}'). "
                 f"Loaded from: '{self.image_path}'."
             )
         else:
             return f"{self.__class__.__name__} loaded from '{self.image_path}'"
 
+    def footprint(self, crs="") -> Polygon:
+        """The product footprint as a Shapely polygon."""
+        return image_footprint(self.image, crs)
+
     def _get_data_from_sidecar(
         self, sidecar_path: Path, target_ureg: UnitRegistry | None = None
     ) -> MetadataLevel2A:

kuva_reader/reader/read.py

@@ -25,7 +25,7 @@ def read_product(
 
     product_map = {
         "L0": Level0Product,
-        "L1AB": Level1ABProduct,
+        "L1B": Level1ABProduct,
         "L1C": Level1CProduct,
         "L2A": Level2AProduct,
     }

{kuva_reader-1.0.3.dist-info → kuva_reader-1.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kuva-reader
-Version: 1.0.3
+Version: 1.0.4
 Summary: Manipulate the Kuva Space image and metadata formats
 License: MIT
 Author: Guillem Ballesteros
@@ -61,8 +61,8 @@ The loaded product is stored in a `rioxarray` object, which contains extensive G
 ```python
 from kuva_reader import read_product
 
-l2a_product = read_product("my_data_folder/hyperfield1a_L2A_20250105T092548")
-print(l2a_product)  # Will show some main information such as image shape and CRS
+product = read_product("my_data_folder/hyperfield1a_L2A_20250105T092548")
+print(product)  # Will show some main information such as image shape and CRS
 ```
 
 This assumes a mostly untouched folder after distributing. Otherwise, you may need to
@@ -75,7 +75,21 @@ l2a_product = Level2AProduct("your/l2a/folder")
 ```
 
 The actual raster image is stored and can be analysed in `product.image`, while metadata
-information of the product is in `product.metadata`. 
+information of the product is in `product.metadata`.
+
+## Other tips
+
+The product object attributes and methods allow the retrieval of other interesting information as well:
+
+```python
+from kuva_reader import read_product
+
+product = read_product("your/product/folder")
+product.footprint(crs="EPSG:4326")  # Footprint with option to transform CRS
+product.image.shape  # The image attribute contains all the image data
+product.wavelengths  # Wavelengths corresponding to image bands
+product.crs  # CRS
+```
 
 ## Processing levels
 

kuva_reader-1.0.4.dist-info/RECORD

@@ -0,0 +1,15 @@
+kuva_reader/__init__.py,sha256=CdpOxA1S2rbwwOZX6oNwfDeta_DoiIayEMhm9tDLizA,1553
+kuva_reader/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kuva_reader/reader/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kuva_reader/reader/image.py,sha256=-3Wsng_is0WRek2Fzi2UY3NCtO6PLsBkFFWTI9fC7xE,5468
+kuva_reader/reader/level0.py,sha256=DyiHRWz_lj2gbxkt3SqYvEaPPo_Sg6Fz7dP4-4XW1qQ,10646
+kuva_reader/reader/level1.py,sha256=VR2s9U4BiA2k8ZvRlbiPhh8nnBIrM82rgwVKN4J8ZVE,8836
+kuva_reader/reader/level2.py,sha256=M6QnlWwb0FdtlBuhn0Ibe9hIdoXT-RFa9p9PSd4ZFMA,4338
+kuva_reader/reader/product_base.py,sha256=_O96DACi2bWEXhNJVuIU328RJ1y1gs7_rMyyEaMo4aA,4294
+kuva_reader/reader/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kuva_reader/reader/read.py,sha256=b5hGFbeJ-7sg-iilSJn29Hcqj4e7kiWT2S0BH2JwcDE,1761
+kuva_reader/reader/utils.py,sha256=oZ1G43nm8lCxzfbdqBs0KhKaXWe_uf-78uBXWvmZigs,1566
+kuva_reader-1.0.4.dist-info/METADATA,sha256=kCQLBjP1xD8QiASHd2xgFsSAbkdL-viFjsCWZ9c_rM4,5053
+kuva_reader-1.0.4.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+kuva_reader-1.0.4.dist-info/entry_points.txt,sha256=YJysY9EChfOb1W_IEht2oE5Z8Y9jA0J6-kofaPv-NdI,149
+kuva_reader-1.0.4.dist-info/RECORD,,

kuva_reader-1.0.3.dist-info/RECORD

@@ -1,15 +0,0 @@
-kuva_reader/__init__.py,sha256=qqsgtVNCkqXFuXOXf5v51ZT_Dcipj1ty0mGUw8fU3sU,1509
-kuva_reader/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kuva_reader/reader/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kuva_reader/reader/image.py,sha256=Ep54Tzila3hKF2I_u-54xnFUf8WqP2fiKAJnbyZxasA,4647
-kuva_reader/reader/level0.py,sha256=-ONYaBH9YFHGaFvJDiDRlmXUWTYPQyQt0XZeuv5sEL4,10370
-kuva_reader/reader/level1.py,sha256=V1gNjz9y185nCJkYpQVcXrmAOQVMaFwIPeIhQJBzaI4,7815
-kuva_reader/reader/level2.py,sha256=lyEbVSLkBxz32ZIEnJih4ln-F_d8h6FTOu1Npt7VHg0,4091
-kuva_reader/reader/product_base.py,sha256=_O96DACi2bWEXhNJVuIU328RJ1y1gs7_rMyyEaMo4aA,4294
-kuva_reader/reader/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kuva_reader/reader/read.py,sha256=l2x-vlOLP8AUMzqSjHLaT7xt0YJtYUjiYWm6btV-rqo,1762
-kuva_reader/reader/utils.py,sha256=oZ1G43nm8lCxzfbdqBs0KhKaXWe_uf-78uBXWvmZigs,1566
-kuva_reader-1.0.3.dist-info/METADATA,sha256=XDxxOJM_4pUzFthDkE8vLYlLTbXtSCRzkOvCCTxYECs,4612
-kuva_reader-1.0.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-kuva_reader-1.0.3.dist-info/entry_points.txt,sha256=YJysY9EChfOb1W_IEht2oE5Z8Y9jA0J6-kofaPv-NdI,149
-kuva_reader-1.0.3.dist-info/RECORD,,