simplestac 2.0.0__py3-none-any.whl

simplestac/__init__.py

@@ -0,0 +1,7 @@
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+    __version__ = version("simplestac")
+except PackageNotFoundError:
+    # package is not installed
+    pass

simplestac/extents.py

@@ -0,0 +1,223 @@
+"""
+Deal with STAC Extents.
+
+# AutoSpatialExtent
+
+The vanilla `pystac.SpatialExtent` enables to describe a spatial extent 
+from several bounding boxes. While this is useful, sometimes we want to
+merge together bounding boxes that are partially overlapping. For instance,
+we can take the example of the France mainland, covered by multiple remote
+sensing products that are generally partially overlapping, and the Corse 
+island that is also covered by a number of RS products, but spatially 
+disjoint from the France mainland RS products bounding boxes. In this 
+particular exemple, we would like to regroup all RS products bounding 
+boxes so that there is one bbox for the France mainland, and another 
+bbox for the Corse island. This is particularly useful when a STAC 
+collection covers sparsely a broad area (e.g. worldwide), with several 
+isolated regions.
+
+The `AutoSpatialExtent` is an extension of the `pystac.SpatialExtent`.
+
+Instances are initialized with the same arguments as `pystac.SpatialExtent`.
+Internally, bounding boxes lists are processed at initialisation, so all 
+partially overlapping bounding boxes are merged and updated as a single one.
+
+# AutoTemporalExtent
+
+The `AutoTemporalExtent` is an extension of the `pystac.TemporalExtent`.
+It computes the date min and date max of a set of dates or dates ranges.
+
+"""
+import pystac
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Union, List
+from numbers import Number
+from annotated_types import Predicate
+from typing_extensions import Annotated
+
+
+def is_bbox(l: List) -> bool:
+    """
+    Predicate to test is the input list represents a bounding box in WGS84.
+
+    Args:
+        l: a list of `Number`
+
+    Returns:
+
+    """
+    if len(l) == 4:
+        if all(isinstance(i, Number) for i in l):
+            if -180 <= l[0] and -90 <= l[1] and l[2] <= 180 and l[3] <= 90:
+                if l[0] <= l[2] and l[1] <= l[3]:
+                    return True
+    return False
+
+
+Bbox = Annotated[list, Predicate(is_bbox)]
+
+
+@dataclass
+class SmartBbox:
+    """
+    Small class to work with a single 2D bounding box.
+    """
+    coords: Bbox = None  # [xmin, ymin, xmax, ymax]
+
+    def touches(self, other: "SmartBbox") -> bool:
+        """
+        Overlap test.
+
+        Args:
+            other: other bounding box
+
+        Returns:
+            True if the other bounding box touches, else False.
+
+        """
+        xmin, ymin, xmax, ymax = self.coords
+        o_xmin, o_ymin, o_xmax, o_ymax = other.coords
+
+        if xmax < o_xmin or o_xmax < xmin or ymax < o_ymin or o_ymax < ymin:
+            return False
+        return True
+
+    def update(self, other: "SmartBbox"):
+        """
+        Update the coordinates of the Bbox. Modifies itself inplace.
+
+        Args:
+            other: other bounding box
+
+        """
+        if not self.coords:
+            self.coords = other.coords
+        else:
+            self.coords = [
+                min(self.coords[0], other.coords[0]),
+                min(self.coords[1], other.coords[1]),
+                max(self.coords[2], other.coords[2]),
+                max(self.coords[3], other.coords[3])
+            ]
+
+
+def clusterize_bboxes(bboxes: list[Bbox]) -> list[Bbox]:
+    """
+    Computes a list of bounding boxes regrouping all overlapping ones.
+
+    Args:
+        bboxes: 2D bounding boxes (list of int of float)
+
+    Returns:
+        list of 2D bounding boxes (list of int of float)
+
+    """
+    bboxes = [SmartBbox(bbox) for bbox in bboxes]
+    clusters = [bboxes.pop()]
+
+    while bboxes:
+        bbox = bboxes.pop()
+        inter_clusters = [
+            i for i, cluster in enumerate(clusters) if bbox.touches(cluster)
+        ]
+        if inter_clusters:
+            # We merge all intersecting clusters into one
+            clusters[inter_clusters[0]].update(bbox)
+            for i in inter_clusters[1:]:
+                clusters[inter_clusters[0]].update(clusters[i])
+            clusters = [
+                cluster
+                for i, cluster in enumerate(clusters)
+                if i not in inter_clusters[1:]
+            ]
+        else:
+            clusters.append(bbox)
+
+    return [cluster.coords for cluster in clusters]
+
+
+class AutoSpatialExtent(pystac.SpatialExtent):
+    """
+    Custom extension of pystac.SpatialExtent that automatically compute bboxes.
+    """
+
+    def __init__(self, *args, **kwargs):
+        """
+        Initializer. Clusterize boxes after the original initializer.
+
+        Args:
+            *args: args
+            **kwargs: keyword args
+
+        """
+        super().__init__(*args, **kwargs)
+        self.clusterize_bboxes()
+
+    def update(self, other: pystac.SpatialExtent | Bbox):
+        """
+        Updates itself with a new spatial extent or bounding box. Modifies
+        inplace `self.bboxes`.
+
+        Args:
+            other: spatial extent or bbox coordinates
+
+        """
+        is_spat_ext = isinstance(other, pystac.SpatialExtent)
+        self.bboxes += other.bboxes if is_spat_ext else other
+        self.clusterize_bboxes()
+
+    def clusterize_bboxes(self):
+        """
+        Regroup the bounding boxes that overlap. Modifies inplace `self.bboxes`.
+
+        """
+        self.bboxes = clusterize_bboxes(self.bboxes)
+
+
+class AutoTemporalExtent(pystac.TemporalExtent):
+    """
+    Custom extension of pystac.TemporalExtent that automatically updates itself
+    with another date or temporal extent provided.
+    """
+
+    def __init__(self, *args, **kwargs):
+        """
+        Initializer. Regroup all intervals into a single one.
+
+        Args:
+            *args: args
+            **kwargs: keyword args
+
+        """
+        super().__init__(*args, **kwargs)
+        self.make_single_interval()
+
+    def update(self, other: Union[pystac.TemporalExtent, datetime]):
+        """
+        Updates itself with a new temporal extent of date. Modifies inplace
+        `self.intervals`.
+
+        Args:
+            other: temporal extent or datetime
+
+        """
+        is_temp_ext = isinstance(other, pystac.TemporalExtent)
+        intervals = other.intervals if is_temp_ext else [[other, other]]
+        self.intervals += intervals
+        self.make_single_interval()
+
+    def make_single_interval(self):
+        all_dates = []
+        for dates_or_intervals in self.intervals:
+            # Because base class (`pystac.SpatialExtent`) converts everything 
+            # into [[...]]
+            for date_or_interval in dates_or_intervals:
+                if isinstance(date_or_interval, (list, tuple)):
+                    all_dates += [i for i in date_or_interval if i is not None]
+                elif isinstance(date_or_interval, datetime):
+                    all_dates.append(date_or_interval)
+                else:
+                    TypeError(f"Unsupported date/range of: {date_or_interval}")
+        self.intervals = \
+            [[min(all_dates), max(all_dates)]] if all_dates else [None, None]

simplestac/formats/S1_GRD.json

@@ -0,0 +1,60 @@
+{
+    "item": {
+        "pattern": "(S1[ABCD]_IW_GRD[FHM_]_1S[SDHV][HV]_[0-9]{8}T[0-9]{6}_[0-9]{8}T[0-9]{6}_[0-9]{6}_[0-9A-Z]{6}_[0-9A-Z]{4})",
+        "properties": {
+            "datetime": {
+                "pattern": "S1[ABCD]_IW_GRD[FHM_]_1S[SDHV][HV]_([0-9]{8}T[0-9]{6})_.*",
+                "format": "%Y%m%dT%H%M%S"
+            },
+            "start_datetime": {
+                "pattern": "S1[ABCD]_IW_GRD[FHM_]_1S[SDHV][HV]_([0-9]{8}T[0-9]{6})_.*",
+                "format": "%Y%m%dT%H%M%S"
+            },
+            "end_datetime": {
+                "pattern": "S1[ABCD]_IW_GRD[FHM_]_1S[SDHV][HV]_[0-9]{8}T[0-9]{6}_([0-9]{8}T[0-9]{6})_.*",
+                "format": "%Y%m%dT%H%M%S"
+            },
+            "title": {
+                "pattern": "(S1[ABCD]_IW_GRD[FHM_]_1S[SDHV][HV]_[0-9]{8}T[0-9]{6}_[0-9]{8}T[0-9]{6}_[0-9]{6}_[0-9A-Z]{6}_[0-9A-Z]{4})"
+            },
+            "platform": {
+                "pattern": "(S1[ABCD]).+"
+            },
+            "sar:instrument_mode": "IW",
+            "sar:frequency_band": "C",
+            "sar:observation_direction": "right",
+            "sar:polarizations": ["VH", "VV"],
+            "sar:product_type": "GRD",
+            "sat:absolute_orbit": {
+                "pattern" : "S1[ABCD]_IW_GRD[FHM_]_1S[SDHV][HV]_[0-9]{8}T[0-9]{6}_[0-9]{8}T[0-9]{6}_([0-9]{6})_[0-9A-Z]{6}_[0-9A-Z]{4}"
+            },
+            "s1:datatake_id": {
+                "pattern" : "S1[ABCD]_IW_GRD[FHM_]_1S[SDHV][HV]_[0-9]{8}T[0-9]{6}_[0-9]{8}T[0-9]{6}_[0-9]{6}_([0-9A-Z]{6})_[0-9A-Z]{4}"
+            },
+            "s1:product_identifier": {
+                "pattern" : "(S1[ABCD]_IW_GRD[FHM_]_1S[SDHV][HV]_[0-9]{8}T[0-9]{6}_[0-9]{8}T[0-9]{6}_[0-9]{6}_[0-9A-Z]{6}_[0-9A-Z]{4})"
+            },
+            "s1:resolution": {
+                "pattern": "S1[ABCD]_IW_GRD([FHM_])_1S[SDHV][HV]_[0-9]{8}T[0-9]{6}_[0-9]{8}T[0-9]{6}_[0-9]{6}_[0-9A-Z]{6}_[0-9A-Z]{4}"
+            }
+        },
+        "stac_extensions": ["sar", "sat"]
+    },
+    "item_assets": {
+        "vv": {
+            "pattern": "s1[abcd]-iw-grd-vv.+\\.tiff",
+            "roles": ["data"],
+            "eo:bands": [{
+                "name": "VV",
+                "description": "VV band: vertical transmit and vertical receive"
+            }]
+        },
+        "vh": {
+            "pattern": "s1[abcd]-iw-grd-vh.+\\.tiff",
+            "roles": ["data"],
+            "eo:bands": [{
+                "name": "VH",
+                "description": "VH band: vertical transmit and horizontal receive"                }]
+        }
+    }
+}

simplestac/formats/S1_RTC_GEODES.json

@@ -0,0 +1,55 @@
+{
+    "item": {
+        "pattern": "(S1[ABCD]_L1ORT_[0-9]{2}[A-Z]{3}_GAM_[A-Z]{3}_[0-9]{3}_[0-9]{8}T[0-9]{6})",
+        "properties": {
+            "datetime": {
+                "pattern": "S1[ABCD]_L1ORT_[0-9]{2}[A-Z]{3}_GAM_[A-Z]{3}_[0-9]{3}_([0-9]{8}T[0-9]{6})",
+                "format": "%Y%m%dT%H%M%S"
+            },
+            "start_datetime": {
+                "pattern": "S1[ABCD]_L1ORT_[0-9]{2}[A-Z]{3}_GAM_[A-Z]{3}_[0-9]{3}_([0-9]{8}T[0-9]{6})",
+                "format": "%Y%m%dT%H%M%S"
+            },
+            "end_datetime": {
+                "pattern": "S1[ABCD]_L1ORT_[0-9]{2}[A-Z]{3}_GAM_[A-Z]{3}_[0-9]{3}_([0-9]{8}T[0-9]{6})",
+                "format": "%Y%m%dT%H%M%S"
+            },
+            "title": {
+                "pattern": "(S1[ABCD]_L1ORT_[0-9]{2}[A-Z]{3}_GAM_[A-Z]{3}_[0-9]{3}_[0-9]{8}T[0-9]{6})"
+            },
+
+            "sat:orbit_state": {
+                "pattern": "S1[ABCD]_L1ORT_[0-9]{2}[A-Z]{3}_GAM_([A-Z]{3})_[0-9]{3}_[0-9]{8}T[0-9]{6}"
+            },
+            "sar:frequency_band": "C",
+            "sar:observation_direction": "right",
+            "sar:polarizations": ["VH", "VV"],
+            "sar:product_type": "GRD_S1Tiling",
+            "sar:instrument_mode": "IW",
+            "sat:relative_orbit": {
+                "pattern" : "S1[ABCD]_L1ORT_[0-9]{2}[A-Z]{3}_GAM_[A-Z]{3}_([0-9]{3})_[0-9]{8}T[0-9]{6}"
+            },
+            "grid:code": {
+                "pattern" : "S1[ABCD]_L1ORT_([0-9]{2}[A-Z]{3})_GAM_[A-Z]{3}_[0-9]{3}_[0-9]{8}T[0-9]{6}"
+            }
+        },
+        "stac_extensions": ["sar", "sat", "grid"]
+    },
+    "item_assets": {
+        "vv": {
+            "pattern": "S1[ABCD]_L1ORT_[0-9]{2}[A-Z]{3}_VV_GAM_[A-Z]{3}_[0-9]{3}_[0-9]{8}T[0-9]{6}\\.tif",
+            "roles": ["data"],
+            "eo:bands": [{
+                "name": "VV",
+                "description": "VV band: vertical transmit and vertical receive"
+            }]
+        },
+        "vh": {
+            "pattern": "S1[ABCD]_L1ORT_[0-9]{2}[A-Z]{3}_VH_GAM_[A-Z]{3}_[0-9]{3}_[0-9]{8}T[0-9]{6}\\.tif",
+            "roles": ["data"],
+            "eo:bands": [{
+                "name": "VH",
+                "description": "VH band: vertical transmit and horizontal receive"                }]
+        }
+    }
+}

simplestac/formats/S2_L2A_THEIA.json

@@ -0,0 +1,166 @@
+{
+  "item" : {
+    "pattern" : "(SENTINEL2[ABC]_[0-9]{8}-[0-9]{6}-[0-9]{3}_L2A_T[0-9A-Z]{5}_[A-Z]_V[0-9]-[0-9])$",
+    "properties": {
+      "datetime" : {
+        "pattern" : "SENTINEL2[ABC]_([0-9]{8}-[0-9]{6})-.*",
+        "format" : "%Y%m%d-%H%M%S"
+      },
+      "title" : {
+        "pattern" : "(SENTINEL2[ABC]_[0-9]{8}-[0-9]{6}-[0-9]{3}_L2A_T[0-9A-Z]{5}_[A-Z]_V[0-9]-[0-9])"
+      },
+      "grid:code" : {
+        "pattern" : ".+_T([0-9A-Z]{5})_.+"
+      },
+      "platform" : {
+        "pattern" : "(SENTINEL2[ABC]).+"
+      },
+      "constellation": "sentinel-2",
+      "instruments" : ["msi"],
+      "product:type" : "S2MSI2A"
+    },
+    "stac_extensions": ["grid"]
+  },
+  "item_assets" : {
+    "B02" : {
+      "pattern" : ".+_FRE_B2\\.tif",
+      "roles" : ["reflectance"],
+      "eo:bands" : [{
+        "name" : "B02",
+        "common_name" : "blue",
+        "center_wavelength": 0.4966,
+        "full_width_half_max": 0.098
+      }]
+    },
+    "B03" : {
+      "pattern" : ".+_FRE_B3\\.tif",
+      "roles" : ["reflectance"],
+      "eo:bands" : [{
+        "name" : "B03",
+        "common_name" : "green",
+        "center_wavelength": 0.56,
+        "full_width_half_max": 0.045
+      }]
+    },
+    "B04" : {
+      "pattern" : ".+_FRE_B4\\.tif",
+      "roles" : ["reflectance"],
+      "eo:bands" : [{
+        "name" : "B04",
+        "common_name" : "red",
+        "center_wavelength": 0.6645,
+        "full_width_half_max": 0.038
+      }]
+    },
+    "B05" : {
+      "pattern" : ".+_FRE_B5\\.tif",
+      "roles" : ["reflectance"],
+      "eo:bands" : [{
+        "name" : "B05",
+        "common_name" : "rededge",
+        "center_wavelength": 0.7039,
+        "full_width_half_max": 0.019
+      }]
+    },
+    "B06" : {
+      "pattern" : ".+_FRE_B6\\.tif",
+      "roles" : ["reflectance"],
+      "eo:bands" : [{
+        "name" : "B06",
+        "common_name" : "rededge",
+        "center_wavelength": 0.7402,
+        "full_width_half_max": 0.018
+      }]
+    },
+    "B07" : {
+      "pattern" : ".+_FRE_B7\\.tif",
+      "roles" : ["reflectance"],
+      "eo:bands" : [{
+        "name" : "B07",
+        "common_name" : "rededge",
+        "center_wavelength": 0.7825,
+        "full_width_half_max": 0.028
+      }]
+    },
+    "B08" : {
+      "pattern" : ".+_FRE_B8\\.tif",
+      "roles" : ["reflectance"],
+      "eo:bands" : [{
+        "name" : "B08",
+        "common_name" : "nir",
+        "center_wavelength": 0.8351,
+        "full_width_half_max": 0.145
+      }]
+    },
+    "B8A" : {
+      "pattern" : ".+_FRE_B8A\\.tif",
+      "roles" : ["reflectance"],
+      "eo:bands" : [{
+        "name" : "B8A",
+        "common_name" : "nir08",
+        "center_wavelength": 0.8648,
+        "full_width_half_max": 0.033
+      }]
+    },
+    "B11" : {
+      "pattern" : ".+_FRE_B11\\.tif",
+      "roles" : ["reflectance"],
+      "eo:bands" : [{
+        "name" : "B11",
+        "common_name" : "swir16",
+        "center_wavelength": 1.6137,
+        "full_width_half_max": 0.143
+      }]
+    },
+    "B12" : {
+      "pattern" : ".+_FRE_B12\\.tif",
+      "roles" : ["reflectance"],
+      "eo:bands" : [{
+        "name" : "B12",
+        "common_name" : "swir22",
+        "center_wavelength": 2.22024,
+        "full_width_half_max": 0.242
+      }]
+    },
+    "CLM_R1" : {
+      "pattern" : ".+_CLM_R1\\.tif",
+      "roles" : ["data"]
+    },
+    "CLM_R2" : {
+      "pattern" : ".+_CLM_R2\\.tif",
+      "roles" : ["data"]
+    },
+    "SAT_R1" : {
+      "pattern" : ".+_SAT_R1\\.tif",
+      "roles" : ["data"]
+    },
+    "SAT_R2" : {
+      "pattern" : ".+_SAT_R2\\.tif",
+      "roles" : ["data"]
+    },
+    "EDG_R1" : {
+      "pattern" : ".+_EDG_R1\\.tif",
+      "roles" : ["data"]
+    },
+    "EDG_R2" : {
+      "pattern" : ".+_EDG_R2\\.tif",
+      "roles" : ["data"]
+    },
+    "MG2_R1" : {
+      "pattern" : ".+_MG2_R1\\.tif",
+      "roles" : ["data"]
+    },
+    "MG2_R2" : {
+      "pattern" : ".+_MG2_R2\\.tif",
+      "roles" : ["data"]
+    },
+    "IAB_R1" : {
+      "pattern" : ".+_IAB_R1\\.tif",
+      "roles" : ["data"]
+    },
+    "IAB_R2" : {
+      "pattern" : ".+_IAB_R2\\.tif",
+      "roles" : ["data"]
+    }
+  }
+}

simplestac/formats/common_name_table.csv

@@ -0,0 +1,17 @@
+Common Name	Band Range (μm)	Landsat 5/7	Landsat 8	Sentinel 2	MODIS	NAIP
+coastal	0.40 - 0.45		1	1		
+blue	0.45 - 0.50	1	2	2	3	3
+green	0.50 - 0.60	2	3	3	4	2
+red	0.60 - 0.70	3	4	4	1	1
+yellow	0.58 - 0.62					
+pan	0.50 - 0.70	8 (L7 only)	8			
+rededge	0.70 - 0.79			5, 6, 7		
+nir	0.75 - 1.00	4		8	2	4
+nir08	0.75 - 0.90		5	8a		
+nir09	0.85 - 1.05			9		
+cirrus	1.35 - 1.40		9	10	26	
+swir16	1.55 - 1.75	5	6	11	6	
+swir22	2.10 - 2.30	7	7	12	7	
+lwir	10.5 - 12.5	6				
+lwir11	10.5 - 11.5		10		31	
+lwir12	11.5 - 12.5		11		32