Show area of interest size

planet_explorer/gui/pe_filters.py

@@ -42,11 +42,13 @@
     QgsCoordinateReferenceSystem,
     QgsCoordinateTransform,
     QgsCsException,
+    QgsDistanceArea,
     QgsFeature,
     QgsGeometry,
     QgsMapLayer,
     QgsProject,
     QgsRectangle,
+    QgsUnitTypes,
     QgsVectorLayer,
     QgsWkbTypes,
 )
@@ -456,6 +458,32 @@ def upload_file(self):
             layer = QgsVectorLayer(filename, "")
             self.aoi_from_layer(layer)
 
+    def show_aoi_area_size(self):
+        """Displays the aoi area size in square kilometers."""
+
+        area_size_sqkm = self.calculate_aoi_area()
+
+        formatted_area_sq = "{:,}".format(round(area_size_sqkm, 2))
+
+        self.laAOISize.setText(f"Total AOI area (sqkm): {formatted_area_sq}")
+
+    def calculate_aoi_area(self):
+        """Calculate the current aoi area in square kilometers"""
+
+        geometry = self.aoi_as_4326_geom()
+        area = QgsDistanceArea()
+        area.setSourceCrs(
+            QgsCoordinateReferenceSystem("EPSG:4326"),
+            QgsProject.instance().transformContext(),
+        )
+        area.setEllipsoid(QgsProject.instance().ellipsoid())
+        geometry_area = area.measureArea(geometry)
+        geometry_area_sq = area.convertAreaMeasurement(
+            geometry_area, QgsUnitTypes.AreaSquareKilometers
+        )
+
+        return round(geometry_area_sq, 2)
+
     def aoi_from_layer(self, layer):
         if not layer.isValid():
             self._show_message("Invalid layer", level=Qgis.Warning, duration=10)
@@ -493,6 +521,7 @@ def aoi_from_layer(self, layer):
                 log.debug("AOI set to layer")
 
                 self.zoom_to_aoi()
+                self.show_aoi_area_size()
 
     def _toggle_selection_tools(self):
         active_layer = iface.activeLayer()
@@ -539,6 +568,7 @@ def aoi_from_current_extent(self):
         log.debug("AOI set to canvas extent")
 
         self.zoom_to_aoi()
+        self.show_aoi_area_size()
 
     @pyqtSlot()
     def aoi_from_active_layer_extent(self):
@@ -574,6 +604,7 @@ def aoi_from_active_layer_extent(self):
         log.debug("AOI set to active layer extent")
 
         self.zoom_to_aoi()
+        self.show_aoi_area_size()
 
     @pyqtSlot()
     def aoi_from_full_extent(self):
@@ -605,6 +636,7 @@ def aoi_from_full_extent(self):
         log.debug("AOI set to full data extent")
 
         self.zoom_to_aoi()
+        self.show_aoi_area_size()
 
     @pyqtSlot()
     def aoi_from_box(self):
@@ -657,6 +689,7 @@ def set_draw_aoi(self, aoi):
 
             self._show_message("AOI set to drawn figure")
             self.zoom_to_aoi()
+            self.show_aoi_area_size()
             if self._cur_maptool is not None:
                 # Restore previously used maptool
                 self._canvas.setMapTool(self._cur_maptool)
@@ -721,6 +754,8 @@ def aoi_from_feature(self):
         self._aoi_box.setToGeometry(geom, QgsCoordinateReferenceSystem("EPSG:4326"))
         self.zoom_to_aoi()
 
+        self.show_aoi_area_size()
+
     @pyqtSlot()
     def aoi_from_bound(self):
         layer = iface.activeLayer()
@@ -758,6 +793,7 @@ def aoi_from_bound(self):
         self._aoi_box.setToGeometry(QgsGeometry.fromRect(bbox_canvas))
 
         self.zoom_to_aoi()
+        self.show_aoi_area_size()
 
     def hide_aoi_if_matches_geom(self, geom):
         color = (
@@ -830,6 +866,7 @@ def validate_edited_aoi(self):
         json_txt = self.leAOI.text()
         if not json_txt:
             self.reset_aoi_box()
+            self.show_aoi_area_size()
             log.debug("No AOI defined, skipping validation")
             return
 
@@ -860,6 +897,7 @@ def validate_edited_aoi(self):
         self.leAOI.blockSignals(False)
 
         self.zoom_to_aoi()
+        self.show_aoi_area_size()
 
 
 class PlanetDailyFilter(DAILY_BASE, DAILY_WIDGET, PlanetFilterMixin):

planet_explorer/tests/test_filters.py

@@ -0,0 +1,75 @@
+import pytest
+
+from qgis.core import QgsGeometry, QgsPoint, QgsPointXY, QgsWkbTypes
+from qgis.gui import QgsRubberBand
+from qgis.utils import iface
+from qgis.PyQt import QtCore
+
+from planet_explorer.gui.pe_filters import PlanetAOIFilter
+
+
+@pytest.mark.parametrize(
+    "name, polygon, expected_size",
+    [
+        pytest.param(
+            "small_polygon",
+            [
+                QgsPointXY(QgsPoint(10, 10)),
+                QgsPointXY(QgsPoint(10, 20)),
+                QgsPointXY(QgsPoint(20, 20)),
+                QgsPointXY(QgsPoint(20, 10)),
+                QgsPointXY(QgsPoint(10, 10)),
+            ],
+            1239202.90,
+            id="area_of_interest_with_small_size",
+        ),
+        pytest.param(
+            "mid_polygon",
+            [
+                QgsPointXY(QgsPoint(10, 10)),
+                QgsPointXY(QgsPoint(10, 40)),
+                QgsPointXY(QgsPoint(40, 40)),
+                QgsPointXY(QgsPoint(40, 10)),
+                QgsPointXY(QgsPoint(10, 10)),
+            ],
+            11152826.13,
+            id="area_of_interest_with_medium_size",
+        ),
+        pytest.param(
+            "large_polygon",
+            [
+                QgsPointXY(QgsPoint(10, 10)),
+                QgsPointXY(QgsPoint(10, 60)),
+                QgsPointXY(QgsPoint(60, 60)),
+                QgsPointXY(QgsPoint(60, 10)),
+                QgsPointXY(QgsPoint(10, 10)),
+            ],
+            30980072.58,
+            id="area_of_interest_with_large_size",
+        ),
+        pytest.param(
+            "small_polygon",
+            [
+                QgsPointXY(QgsPoint(0, 0)),
+                QgsPointXY(QgsPoint(0, 0)),
+                QgsPointXY(QgsPoint(0, 0)),
+                QgsPointXY(QgsPoint(0, 0)),
+                QgsPointXY(QgsPoint(0, 0)),
+            ],
+            0.0,
+            id="area_of_interest_with_zero_size",
+        ),
+    ],
+)
+def test_aoi_area_size_calculation(name, polygon, expected_size):
+    """Tests the filter for calculating the aoi size in square kilometers"""
+    aoi_filter = PlanetAOIFilter()
+    aoi_box = QgsRubberBand(iface.mapCanvas(), QgsWkbTypes.PolygonGeometry)
+
+    geometry = QgsGeometry.fromPolygonXY([polygon])
+    aoi_box.setToGeometry(geometry)
+
+    aoi_filter._aoi_box = aoi_box
+    size = aoi_filter.calculate_aoi_area()
+
+    assert size == expected_size

planet_explorer/ui/pe_aoi_filter_base.ui

@@ -6,8 +6,8 @@
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>612</width>
-    <height>85</height>
+    <width>613</width>
+    <height>148</height>
    </rect>
   </property>
   <property name="sizePolicy">
@@ -269,6 +269,26 @@
         </layout>
        </widget>
       </item>
+      <item>
+       <spacer name="horizontalSpacer_2">
+        <property name="orientation">
+         <enum>Qt::Horizontal</enum>
+        </property>
+        <property name="sizeHint" stdset="0">
+         <size>
+          <width>40</width>
+          <height>20</height>
+         </size>
+        </property>
+       </spacer>
+      </item>
+      <item>
+       <widget class="QLabel" name="laAOISize">
+        <property name="text">
+         <string>Total AOI area (sqkm):</string>
+        </property>
+       </widget>
+      </item>
      </layout>
     </widget>
    </item>