Merge pull request #363 from emmanuelmathot/solar_illum

Add solar_illumination field in eo extension

Author: Jon Duckworth

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Added
 
+- solar_illumination field in eo extension ([#356](https://github.com/stac-utils/pystac/issues/356))
 - Added `Link.canonical` static method for creating links with "canonical" rel type ([#351](https://github.com/stac-utils/pystac/pull/351))
 - Added `RelType` enum containing common `rel` values ([#351](https://github.com/stac-utils/pystac/pull/351))
 

pystac/extensions/eo.py

@@ -53,6 +53,7 @@ def apply(
         description: Optional[str] = None,
         center_wavelength: Optional[float] = None,
         full_width_half_max: Optional[float] = None,
+        solar_illumination: Optional[float] = None,
     ) -> None:
         """
         Sets the properties for this Band.
@@ -66,12 +67,15 @@ def apply(
             center_wavelength : The center wavelength of the band, in micrometers (μm).
             full_width_half_max : Full width at half maximum (FWHM). The width of the band,
                 as measured at half the maximum transmission, in micrometers (μm).
+            solar_illumination: The solar illumination of the band,
+                as measured at half the maximum transmission, in W/m2/micrometers.
         """  # noqa
         self.name = name
         self.common_name = common_name
         self.description = description
         self.center_wavelength = center_wavelength
         self.full_width_half_max = full_width_half_max
+        self.solar_illumination = solar_illumination
 
     @classmethod
     def create(
@@ -81,6 +85,7 @@ def create(
         description: Optional[str] = None,
         center_wavelength: Optional[float] = None,
         full_width_half_max: Optional[float] = None,
+        solar_illumination: Optional[float] = None,
     ) -> "Band":
         """
         Creates a new band.
@@ -94,6 +99,8 @@ def create(
             center_wavelength : The center wavelength of the band, in micrometers (μm).
             full_width_half_max : Full width at half maximum (FWHM). The width of the band,
                 as measured at half the maximum transmission, in micrometers (μm).
+            solar_illumination: The solar illumination of the band,
+                as measured at half the maximum transmission, in W/m2/micrometers.
         """  # noqa
         b = cls({})
         b.apply(
@@ -102,6 +109,7 @@ def create(
             description=description,
             center_wavelength=center_wavelength,
             full_width_half_max=full_width_half_max,
+            solar_illumination=solar_illumination,
         )
         return b
 
@@ -186,6 +194,23 @@ def full_width_half_max(self, v: Optional[float]) -> None:
         else:
             self.properties.pop("full_width_half_max", None)
 
+    @property
+    def solar_illumination(self) -> Optional[float]:
+        """Get or sets the solar illumination of the band,
+            as measured at half the maximum transmission, in W/m2/micrometers.
+
+        Returns:
+            [float]
+        """
+        return self.properties.get("solar_illumination")
+
+    @solar_illumination.setter
+    def solar_illumination(self, v: Optional[float]) -> None:
+        if v is not None:
+            self.properties["solar_illumination"] = v
+        else:
+            self.properties.pop("solar_illumination", None)
+
     def __repr__(self) -> str:
         return "<Band name={}>".format(self.name)
 

tests/data-files/eo/eo-landsat-example.json

@@ -65,7 +65,8 @@
           "name": "B1",
           "common_name": "coastal",
           "center_wavelength": 0.44,
-          "full_width_half_max": 0.02
+          "full_width_half_max": 0.02,
+          "solar_illumination": 2000
         }
       ]
     },

tests/extensions/test_eo.py

@@ -93,6 +93,7 @@ def test_asset_bands(self) -> None:
         assert asset_bands is not None
         self.assertEqual(len(asset_bands), 1)
         self.assertEqual(asset_bands[0].name, "B1")
+        self.assertEqual(asset_bands[0].solar_illumination, 2000)
 
         index_asset = item.assets["index"]
         asset_bands = EOExtension.ext(index_asset).bands
@@ -115,9 +116,21 @@ def test_asset_bands(self) -> None:
 
         # Check adding a new asset
         new_bands = [
-            Band.create(name="red", description=Band.band_description("red")),
-            Band.create(name="green", description=Band.band_description("green")),
-            Band.create(name="blue", description=Band.band_description("blue")),
+            Band.create(
+                name="red",
+                description=Band.band_description("red"),
+                solar_illumination=1900,
+            ),
+            Band.create(
+                name="green",
+                description=Band.band_description("green"),
+                solar_illumination=1950,
+            ),
+            Band.create(
+                name="blue",
+                description=Band.band_description("blue"),
+                solar_illumination=2000,
+            ),
         ]
         asset = pystac.Asset(href="some/path.tif", media_type=pystac.MediaType.GEOTIFF)
         EOExtension.ext(asset).bands = new_bands