Support STAC-1.1-style bands from CollectionMetadata._parse_dimensions

related to eu-cdse/openeo-cdse-infra#799 (load_stac based collection configuration)

Author: soxofaan

openeo/_version.py

@@ -1 +1 @@
-__version__ = "0.47.0a1"
+__version__ = "0.47.0a2"

openeo/metadata.py

@@ -588,22 +588,23 @@ def _parse_dimensions(cls, spec: dict, complain: Callable[[str], None] = _log.wa
                 dimensions.append(Dimension(name=name, type=dim_type))
 
         # Detailed band information: `summaries/[eo|raster]:bands` (and 0.4 style `properties/eo:bands`)
-        eo_bands = (
-            deep_get(spec, "summaries", "eo:bands", default=None)
+        summaries_bands = (
+            deep_get(spec, "summaries", "bands", default=None)
+            or deep_get(spec, "summaries", "eo:bands", default=None)
             or deep_get(spec, "summaries", "raster:bands", default=None)
             or deep_get(spec, "properties", "eo:bands", default=None)
         )
-        if eo_bands:
-            # center_wavelength is in micrometer according to spec
+        if summaries_bands:
             bands_detailed = [
                 Band(
                     name=b["name"],
-                    common_name=b.get("common_name"),
-                    wavelength_um=b.get("center_wavelength"),
+                    common_name=b.get("eo:common_name") or b.get("common_name"),
+                    # center_wavelength is in micrometer according to spec
+                    wavelength_um=b.get("eo:center_wavelength") or b.get("center_wavelength"),
                     aliases=b.get("aliases"),
                     gsd=b.get("openeo:gsd"),
                 )
-                for b in eo_bands
+                for b in summaries_bands
             ]
             # Update band dimension with more detailed info
             band_dimensions = [d for d in dimensions if d.type == "bands"]

tests/test_metadata.py

@@ -332,7 +332,28 @@ def test_get_dimensions_cube_dimensions_no_band_names():
     assert logs == ["No band names in dimension 'spectral'"]
 
 
-def test_get_dimensions_cube_dimensions_eo_bands():
+@pytest.mark.parametrize(
+    "summaries",
+    [
+        {
+            # Pre-STAC-1.1-style eo:bands
+            "eo:bands": [
+                {"name": "r", "common_name": "red", "center_wavelength": 5},
+                {"name": "g", "center_wavelength": 8},
+                {"name": "b", "common_name": "blue"},
+            ]
+        },
+        {
+            # STAC 1.1-style bands
+            "bands": [
+                {"name": "r", "eo:common_name": "red", "eo:center_wavelength": 5},
+                {"name": "g", "eo:center_wavelength": 8},
+                {"name": "b", "eo:common_name": "blue"},
+            ]
+        },
+    ],
+)
+def test_get_dimensions_cube_dimensions_eo_bands(summaries):
     dims = CollectionMetadata._parse_dimensions(
         {
             "cube:dimensions": {
@@ -341,13 +362,7 @@ def test_get_dimensions_cube_dimensions_eo_bands():
                 "t": {"type": "temporal", "extent": ["2020-02-20", None]},
                 "spectral": {"type": "bands", "values": ["r", "g", "b"]},
             },
-            "summaries": {
-                "eo:bands": [
-                    {"name": "r", "common_name": "red", "center_wavelength": 5},
-                    {"name": "g", "center_wavelength": 8},
-                    {"name": "b", "common_name": "blue"},
-                ]
-            },
+            "summaries": summaries,
         }
     )
     assert_same_dimensions(
@@ -368,21 +383,36 @@ def test_get_dimensions_cube_dimensions_eo_bands():
     )
 
 
-def test_get_dimensions_cube_dimensions_eo_bands_mismatch():
+@pytest.mark.parametrize(
+    "summaries",
+    [
+        {
+            # Pre-STAC-1.1-style eo:bands
+            "eo:bands": [
+                {"name": "y", "common_name": "yellow", "center_wavelength": 5},
+                {"name": "c", "center_wavelength": 8},
+                {"name": "m", "common_name": "magenta"},
+            ]
+        },
+        {
+            # STAC 1.1-style bands
+            "bands": [
+                {"name": "y", "eo:common_name": "yellow", "eo:center_wavelength": 5},
+                {"name": "c", "eo:center_wavelength": 8},
+                {"name": "m", "eo:common_name": "magenta"},
+            ]
+        },
+    ],
+)
+def test_get_dimensions_cube_dimensions_eo_bands_mismatch(summaries):
     logs = []
     dims = CollectionMetadata._parse_dimensions(
         {
             "cube:dimensions": {
                 "x": {"type": "spatial", "extent": [-10, 10]},
                 "spectral": {"type": "bands", "values": ["r", "g", "b"]},
             },
-            "summaries": {
-                "eo:bands": [
-                    {"name": "y", "common_name": "yellow", "center_wavelength": 5},
-                    {"name": "c", "center_wavelength": 8},
-                    {"name": "m", "common_name": "magenta"},
-                ]
-            },
+            "summaries": summaries,
         },
         complain=logs.append,
     )
@@ -403,7 +433,28 @@ def test_get_dimensions_cube_dimensions_eo_bands_mismatch():
     assert logs == ["Band name mismatch: ['r', 'g', 'b'] != ['y', 'c', 'm']"]
 
 
-def test_get_dimensions_eo_bands_only():
+@pytest.mark.parametrize(
+    "summaries",
+    [
+        {
+            # Pre-STAC-1.1-style eo:bands
+            "eo:bands": [
+                {"name": "y", "common_name": "yellow", "center_wavelength": 5},
+                {"name": "c", "center_wavelength": 8},
+                {"name": "m", "common_name": "magenta"},
+            ]
+        },
+        {
+            # STAC 1.1-style bands
+            "bands": [
+                {"name": "y", "eo:common_name": "yellow", "eo:center_wavelength": 5},
+                {"name": "c", "eo:center_wavelength": 8},
+                {"name": "m", "eo:common_name": "magenta"},
+            ]
+        },
+    ],
+)
+def test_get_dimensions_eo_bands_only(summaries):
     logs = []
     dims = CollectionMetadata._parse_dimensions(
         {
@@ -433,20 +484,35 @@ def test_get_dimensions_eo_bands_only():
     assert logs == ["No cube:dimensions metadata", "Assuming name 'bands' for anonymous band dimension."]
 
 
-def test_get_dimensions_no_band_dimension_with_eo_bands():
+@pytest.mark.parametrize(
+    "summaries",
+    [
+        {
+            # Pre-STAC-1.1-style eo:bands
+            "eo:bands": [
+                {"name": "y", "common_name": "yellow", "center_wavelength": 5},
+                {"name": "c", "center_wavelength": 8},
+                {"name": "m", "common_name": "magenta"},
+            ]
+        },
+        {
+            # STAC 1.1-style bands
+            "bands": [
+                {"name": "y", "eo:common_name": "yellow", "eo:center_wavelength": 5},
+                {"name": "c", "eo:center_wavelength": 8},
+                {"name": "m", "eo:common_name": "magenta"},
+            ]
+        },
+    ],
+)
+def test_get_dimensions_no_band_dimension_with_eo_bands(summaries):
     logs = []
     dims = CollectionMetadata._parse_dimensions(
         {
             "cube:dimensions": {
                 "x": {"type": "spatial", "extent": [-10, 10]},
             },
-            "summaries": {
-                "eo:bands": [
-                    {"name": "y", "common_name": "yellow", "center_wavelength": 5},
-                    {"name": "c", "center_wavelength": 8},
-                    {"name": "m", "common_name": "magenta"},
-                ]
-            },
+            "summaries": summaries,
         },
         complain=logs.append,
     )
@@ -459,7 +525,24 @@ def test_get_dimensions_no_band_dimension_with_eo_bands():
     assert logs == ["No 'bands' dimension in 'cube:dimensions' while having 'eo:bands' or 'raster:bands'"]
 
 
-def test_get_dimensions_multiple_band_dimensions_with_eo_bands():
+@pytest.mark.parametrize(
+    "summaries",
+    [
+        {
+            # Pre-STAC-1.1-style eo:bands
+            "eo:bands": [
+                {"name": "zu", "common_name": "foo"},
+            ]
+        },
+        {
+            # STAC 1.1-style bands
+            "bands": [
+                {"name": "zu", "eo:common_name": "foo"},
+            ]
+        },
+    ],
+)
+def test_get_dimensions_multiple_band_dimensions_with_eo_bands(summaries):
     logs = []
     dims = CollectionMetadata._parse_dimensions(
         {
@@ -468,11 +551,7 @@ def test_get_dimensions_multiple_band_dimensions_with_eo_bands():
                 "spectral": {"type": "bands", "values": ["alpha", "beta"]},
                 "bands": {"type": "bands", "values": ["r", "g", "b"]},
             },
-            "summaries": {
-                "eo:bands": [
-                    {"name": "zu", "common_name": "foo"},
-                ]
-            },
+            "summaries": summaries,
         },
         complain=logs.append,
     )
@@ -574,18 +653,24 @@ def test_cubemetadata_bands_dimension_no_band_dimensions():
 @pytest.mark.parametrize(
     "spec",
     [
-        # API 0.4 style
         {
+            # API 0.4 style
             "properties": {
                 "eo:bands": [{"name": "foo", "common_name": "F00", "center_wavelength": 0.543}, {"name": "bar"}]
             }
         },
-        # API 1.0 style
         {
+            # API 1.0 style
             "summaries": {
                 "eo:bands": [{"name": "foo", "common_name": "F00", "center_wavelength": 0.543}, {"name": "bar"}]
             }
         },
+        {
+            # STAC 1.1 style
+            "summaries": {
+                "bands": [{"name": "foo", "eo:common_name": "F00", "eo:center_wavelength": 0.543}, {"name": "bar"}]
+            }
+        },
     ],
 )
 def test_metadata_bands_dimension_eo_bands(spec):
@@ -599,8 +684,8 @@ def test_metadata_bands_dimension_eo_bands(spec):
 @pytest.mark.parametrize(
     "spec",
     [
-        # API 0.4 style
         {
+            # API 0.4 style
             "properties": {
                 "cube:dimensions": {
                     "x": {"type": "spatial", "axis": "x"},
@@ -609,8 +694,8 @@ def test_metadata_bands_dimension_eo_bands(spec):
                 "eo:bands": [{"name": "foo", "common_name": "F00", "center_wavelength": 0.543}, {"name": "bar"}],
             }
         },
-        # API 1.0 style
         {
+            # API 1.0 style
             "cube:dimensions": {
                 "x": {"type": "spatial", "axis": "x"},
                 "b": {"type": "bands", "values": ["foo", "bar"]},
@@ -619,6 +704,16 @@ def test_metadata_bands_dimension_eo_bands(spec):
                 "eo:bands": [{"name": "foo", "common_name": "F00", "center_wavelength": 0.543}, {"name": "bar"}]
             },
         },
+        {
+            # STAC 1.1 bands style
+            "cube:dimensions": {
+                "x": {"type": "spatial", "axis": "x"},
+                "b": {"type": "bands", "values": ["foo", "bar"]},
+            },
+            "summaries": {
+                "bands": [{"name": "foo", "eo:common_name": "F00", "eo:center_wavelength": 0.543}, {"name": "bar"}]
+            },
+        },
     ],
 )
 def test_metadata_bands_dimension(spec):
@@ -996,6 +1091,10 @@ def filter_bbox(self, bbox):
             StacDummyBuilder.collection(summaries={"eo:bands": [{"name": "B01"}, {"name": "B02"}]}),
             ["B01", "B02"],
         ),
+        (
+            StacDummyBuilder.collection(summaries={"bands": [{"name": "B01"}, {"name": "B02"}]}),
+            ["B01", "B02"],
+        ),
         # TODO: test asset handling in collection?
         (
             StacDummyBuilder.catalog(),
@@ -1007,6 +1106,12 @@ def filter_bbox(self, bbox):
             ),
             ["SCL", "B08"],
         ),
+        (
+            StacDummyBuilder.item(
+                properties={"datetime": "2020-05-22T00:00:00Z", "bands": [{"name": "SCL"}, {"name": "B08"}]}
+            ),
+            ["SCL", "B08"],
+        ),
         # TODO: test asset handling in item?
     ],
 )