-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #731 from kartoza/timlinux/issue702
Generate aggregate per subnational boundary by calculating the zonal stats mean of WEE
- Loading branch information
Showing
7 changed files
with
869 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| from .area_iterator import AreaIterator | ||
| from .population_processor import PopulationRasterProcessingTask | ||
| from .wee_score_processor import WEEByPopulationScoreProcessingTask | ||
| from .subnational_aggregation_processor import SubnationalAggregationProcessingTask |
197 changes: 197 additions & 0 deletions
197
geest/core/algorithms/subnational_aggregation_processor.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,197 @@ | ||
| import os | ||
| import traceback | ||
| from typing import Optional, List | ||
| import shutil | ||
|
|
||
| from qgis.PyQt.QtCore import QVariant | ||
| from qgis.core import ( | ||
| QgsVectorLayer, | ||
| QgsCoordinateReferenceSystem, | ||
| QgsTask, | ||
| ) | ||
| import processing | ||
| from geest.utilities import log_message, resources_path | ||
|
|
||
|
|
||
| class SubnationalAggregationProcessingTask(QgsTask): | ||
| """ | ||
| A QgsTask subclass for calculating WEE x Population SCORE and or WEE score per aggregation area. | ||
| It iterates over subnational boundaries, calculates the majoriy WEE SCORE or WEE x Population Score | ||
| into a geopackage with the same polygons as original subnational boundaries but new attributes for | ||
| the majority scores and applies a QML style. | ||
| The subnational boundaries will NOT be split bu the study area polygons, so | ||
| containment is not guaranteed between study area polygons and the subnational boundary polygons. | ||
| Because of this, we will use the VRT combined outputs for the WEE SCORE and WEE x Population Score | ||
| inputs. | ||
| It will write 4 columns to the output gpkg: | ||
| fid - generic incrementing id for each subnational area | ||
| name - subnational area name | ||
| wee_score - majority wee score for that subnational area | ||
| wee_pop_score - majority wee x population score for that subnational area | ||
| The WEE Score can be one of 5 classes: | ||
| | Range | Description | Color | | ||
| |--------|---------------------------|------------| | ||
| | 0 - 1 | Very Low Enablement |  `#FF0000` | | ||
| | 1 - 2 | Low Enablement |  `#FFA500` | | ||
| | 2 - 3 | Moderately Enabling |  `#FFFF00` | | ||
| | 3 - 4 | Enabling |  `#90EE90` | | ||
| | 4 - 5 | Highly Enabling |  `#0000FF` | | ||
| The WEE x Population Score can be one of 15 classes: | ||
| | Color | Description | | ||
| |------------|---------------------------------------------| | ||
| |  `#FF0000` | Very low enablement, low population | | ||
| |  `#FF0000` | Very low enablement, medium population | | ||
| |  `#FF0000` | Very low enablement, high population | | ||
| |  `#FFA500` | Low enablement, low population | | ||
| |  `#FFA500` | Low enablement, medium population | | ||
| |  `#FFA500` | Low enablement, high population | | ||
| |  `#FFFF00` | Moderately enabling, low population | | ||
| |  `#FFFF00` | Moderately enabling, medium population | | ||
| |  `#FFFF00` | Moderately enabling, high population | | ||
| |  `#90EE90` | Enabling, low population | | ||
| |  `#90EE90` | Enabling, medium population | | ||
| |  `#90EE90` | Enabling, high population | | ||
| |  `#0000FF` | Highly enabling, low population | | ||
| |  `#0000FF` | Highly enabling, medium population | | ||
| |  `#0000FF` | Highly enabling, high population | | ||
| See the wee_score_processor.py module for more details on how this is computed. | ||
| 📒 The majority score for each subnational area is calculated by counting the | ||
| number of pixels in each WEE Score and WEE x Population Score class as per the | ||
| above tables. Then majority pixel count is then allocated to the aggregate area. | ||
| In the unlikely event of there being two or more classes with an equal pixel count, | ||
| the highest enablement and population class is assigned. | ||
| See zonalstatisticsfb algorithm for more details on how the majority score is calculated. | ||
| https://qgis.org/pyqgis/3.34/analysis/QgsZonalStatistics.html#qgis.analysis.QgsZonalStatistics.Majority | ||
| Args: | ||
| study_area_gpkg_path (str): Path to the study area geopackage. Used to determine the CRS. | ||
| aggregation_areas_path (str): Path to vector layer containing the aggregation areas. | ||
| working_directory (str): Parent directory to save the output agregated data. Outputs will | ||
| be saved in a subdirectory called "subnational_aggregates". | ||
| target_crs (Optional[QgsCoordinateReferenceSystem]): CRS for the output rasters. | ||
| force_clear (bool): Flag to force clearing of all outputs before processing. | ||
| """ | ||
|
|
||
| def __init__( | ||
| self, | ||
| study_area_gpkg_path: str, | ||
| aggregation_areas_path: str, | ||
| working_directory: str, | ||
| target_crs: Optional[QgsCoordinateReferenceSystem] = None, | ||
| force_clear: bool = False, | ||
| ): | ||
| super().__init__("Subnational Aggregation Processor", QgsTask.CanCancel) | ||
| self.study_area_gpkg_path = study_area_gpkg_path | ||
|
|
||
| self.aggregation_areas_path = aggregation_areas_path | ||
|
|
||
| self.aggregation_layer: QgsVectorLayer = QgsVectorLayer( | ||
| self.aggregation_areas_path, | ||
| "aggregation_areas", | ||
| "ogr", | ||
| ) | ||
| if not self.aggregation_layer.isValid(): | ||
| raise Exception("Invalid aggregation areas layer.") | ||
|
|
||
| self.output_dir = os.path.join(working_directory, "subnational_aggregation") | ||
| os.makedirs(self.output_dir, exist_ok=True) | ||
|
|
||
| # These folders should already exist from the aggregation analysis and population raster processing | ||
| self.population_folder = os.path.join(working_directory, "population") | ||
| self.wee_folder = os.path.join(working_directory, "wee_score") | ||
|
|
||
| if not os.path.exists(self.population_folder): | ||
| raise Exception( | ||
| "Population folder not found. Please run population raster processing first." | ||
| ) | ||
| if not os.path.exists(self.wee_folder): | ||
| raise Exception( | ||
| "WEE folder not found. Please run WEE raster processing first." | ||
| ) | ||
|
|
||
| self.force_clear = force_clear | ||
| if self.force_clear and os.path.exists(self.output_dir): | ||
| for file in os.listdir(self.output_dir): | ||
| os.remove(os.path.join(self.output_dir, file)) | ||
|
|
||
| self.target_crs = target_crs | ||
| if not self.target_crs: | ||
| layer: QgsVectorLayer = QgsVectorLayer( | ||
| f"{self.study_area_gpkg_path}|layername=study_area_clip_polygons", | ||
| "study_area_clip_polygons", | ||
| "ogr", | ||
| ) | ||
| self.target_crs = layer.crs() | ||
| del layer | ||
|
|
||
| log_message("Initialized WEE Subnational Area Aggregation Processing Task") | ||
|
|
||
| def run(self) -> bool: | ||
| """ | ||
| Executes the WEE Subnational Area Aggregation Processing Task calculation task. | ||
| """ | ||
| try: | ||
| self.aggregate() | ||
| self.apply_qml_style( | ||
| source_qml=resources_path("qml/wee_by_population_vector_score.qml.qml"), | ||
| qml_path=os.path.join( | ||
| self.output_dir, "wee_by_population_vector_score.qml" | ||
| ), | ||
| ) | ||
| return True | ||
| except Exception as e: | ||
| log_message(f"Task failed: {e}") | ||
| log_message(traceback.format_exc()) | ||
| return False | ||
|
|
||
| def aggregate(self) -> None: | ||
| """Fix geometries then use aggregation vector to calculate the majority WEE SCORE and WEE x Population Score for each valid polygon.""" | ||
|
|
||
| params = { | ||
| "INPUT": self.aggregation_layer, | ||
| "METHOD": 1, # Structur method | ||
| "OUTPUT": "TEMPORARY_OUTPUT", | ||
| } | ||
| output = processing.run("native:fixgeometries", params)["OUTPUT"] | ||
|
|
||
| params = { | ||
| "INPUT": output, | ||
| "INPUT_RASTER": os.path.join( | ||
| self.wee_folder, "wee_by_population_score.vrt" | ||
| ), | ||
| "RASTER_BAND": 1, | ||
| "COLUMN_PREFIX": "_", | ||
| "STATISTICS": [9], # Majority | ||
| "OUTPUT": os.path.join(self.output_dir, "subnational_aggregation.gpkg"), | ||
| } | ||
| processing.run("native:zonalstatisticsfb", params) | ||
|
|
||
| def apply_qml_style(self, source_qml: str, qml_path: str) -> None: | ||
|
|
||
| # Apply QML Style | ||
| if os.path.exists(source_qml): | ||
| shutil.copy(source_qml, qml_path) | ||
| log_message(f"Copied QML style from {source_qml} to {qml_path}") | ||
| else: | ||
| log_message("QML style file not found. Skipping QML copy.") | ||
|
|
||
| def finished(self, result: bool) -> None: | ||
| """ | ||
| Called when the task completes. | ||
| """ | ||
| if result: | ||
| log_message("WEE SCORE calculation completed successfully.") | ||
| else: | ||
| log_message("WEE SCORE calculation failed.") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.