-
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 #736 from kartoza/timlinux/issue704
Mask implementations
- Loading branch information
Showing
5 changed files
with
494 additions
and
2 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
254 changes: 254 additions & 0 deletions
254
geest/core/algorithms/opportunities_by_wee_score_population_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,254 @@ | ||
| import os | ||
| import traceback | ||
| from typing import Optional, List | ||
| import shutil | ||
|
|
||
| from qgis.core import ( | ||
| QgsTask, | ||
| QgsRasterLayer, | ||
| QgsVectorLayer, | ||
| QgsCoordinateReferenceSystem, | ||
| ) | ||
| import processing | ||
| from geest.utilities import log_message, resources_path | ||
| from geest.core.algorithms import AreaIterator | ||
|
|
||
|
|
||
| class OpportunitiesByWeeScorePopulationProcessingTask(QgsTask): | ||
| """ | ||
| A QgsTask subclass for calculating masked WEE SCORE x Population using raster algebra. | ||
| It iterates over study areas, gets the WEE SCORE x Population and applies the Job Opportunities | ||
| mask to it. It then combines the resulting rasters into a VRT, and applies a QML style. | ||
| It takes as input a WEE Score layer (output as the result of Analysis level aggregation | ||
| of GEEST workflow). This WEE Score layer has the following 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 | | ||
| Additionally a mask layer containing cell values of 1 for included areas is required. | ||
| One sub product is made per study area and then all of the study area outputs are | ||
| combined as a VRT and assigned a QML with the correct legend colours. | ||
| Args: | ||
| study_area_gpkg_path (str): Path to the GeoPackage containing study area masks. | ||
| working_directory (str): Directory to save the output rasters. | ||
| 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, | ||
| working_directory: str, | ||
| target_crs: Optional[QgsCoordinateReferenceSystem] = None, | ||
| force_clear: bool = False, | ||
| ): | ||
| super().__init__( | ||
| "Opportunities WEE Score by Population Processor", QgsTask.CanCancel | ||
| ) | ||
| self.study_area_gpkg_path = study_area_gpkg_path | ||
|
|
||
| self.output_dir = os.path.join( | ||
| working_directory, "opportunities_by_wee_score_by_population" | ||
| ) | ||
| os.makedirs(self.output_dir, exist_ok=True) | ||
|
|
||
| # These folders should already exist from the analysis and opportunities mask processor | ||
| self.opportunity_masks_folder = os.path.join( | ||
| working_directory, "opportunity_masks" | ||
| ) | ||
| self.wee_folder = os.path.join(working_directory, "wee_by_population_score") | ||
|
|
||
| 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 | ||
| self.output_rasters: List[str] = [] | ||
|
|
||
| log_message( | ||
| "Initialized Opportunities Mask by WEE SCORE by Population Processing Task" | ||
| ) | ||
|
|
||
| def run(self) -> bool: | ||
| """ | ||
| Executes the Opportunities by WEE SCORE by Population calculation task. | ||
| """ | ||
| try: | ||
| self.calculate_score() | ||
| self.generate_vrt() | ||
| return True | ||
| except Exception as e: | ||
| log_message(f"Task failed: {e}") | ||
| log_message(traceback.format_exc()) | ||
| return False | ||
|
|
||
| def validate_rasters( | ||
| self, | ||
| opportunities_mask_raster: QgsRasterLayer, | ||
| wee_score_by_population_raster: QgsRasterLayer, | ||
| dimension_check=False, | ||
| ) -> None: | ||
| """ | ||
| Checks if Opportunities Mask and WEE Score by Population | ||
| rasters have the same origin, dimensions, and pixel sizes. | ||
| Raises an exception if the check fails. | ||
| Args: | ||
| opportunities_mask_raster (QgsRasterLayer): Path to the mask raster. | ||
| wee_score_by_population_raster (QgsRasterLayer): Path to the WEE Score by Population raster. | ||
| dimension_check (bool): Flag to check if the rasters have the same dimensions. | ||
| returns: | ||
| None | ||
| """ | ||
| log_message("Validating input rasters") | ||
| log_message(f"opportunities_mask_raster: {opportunities_mask_raster.source()}") | ||
| log_message( | ||
| f"wee_score_by_population raster raster : {wee_score_by_population_raster.source()}" | ||
| ) | ||
|
|
||
| if ( | ||
| not opportunities_mask_raster.isValid() | ||
| or not wee_score_by_population_raster.isValid() | ||
| ): | ||
| raise ValueError("One or both input rasters are invalid.") | ||
|
|
||
| if not dimension_check: | ||
| return | ||
|
|
||
| mask_provider = opportunities_mask_raster.dataProvider() | ||
| wee_score_by_population_provider = wee_score_by_population_raster.dataProvider() | ||
|
|
||
| mask_extent = mask_provider.extent() | ||
| wee_score_by_population_size = wee_score_by_population_provider.extent() | ||
| if mask_extent != wee_score_by_population_size: | ||
| raise ValueError("Input rasters do not share the same extent.") | ||
|
|
||
| mask_size = mask_provider.xSize(), mask_provider.ySize() | ||
| wee_score_by_population_size = ( | ||
| wee_score_by_population_provider.xSize(), | ||
| wee_score_by_population_provider.ySize(), | ||
| ) | ||
| if mask_size != wee_score_by_population_size: | ||
| raise ValueError("Input rasters do not share the same dimensions.") | ||
|
|
||
| log_message("Validation successful: rasters are aligned.") | ||
|
|
||
| def calculate_score(self) -> None: | ||
| """ | ||
| Calculates Mask x WEE SCORE by Population using raster | ||
| algebra and saves the result for each area. | ||
| """ | ||
| area_iterator = AreaIterator(self.study_area_gpkg_path) | ||
| for index, (_, _, _, _) in enumerate(area_iterator): | ||
| if self.isCanceled(): | ||
| return | ||
|
|
||
| mask_path = os.path.join( | ||
| self.opportunity_masks_folder, f"opportunites_mask_{index}.tif" | ||
| ) | ||
| wee_score_by_population_path = os.path.join( | ||
| self.wee_folder, f"wee_by_population_score_{index}.tif" | ||
| ) | ||
| mask_layer = QgsRasterLayer(mask_path, "WEE") | ||
| wee_score_by_population_layer = QgsRasterLayer( | ||
| wee_score_by_population_path, "POP" | ||
| ) | ||
| self.validate_rasters( | ||
| mask_layer, wee_score_by_population_layer, dimension_check=False | ||
| ) | ||
|
|
||
| output_path = os.path.join( | ||
| self.output_dir, f"wee_by_opportunities_mask_{index}.tif" | ||
| ) | ||
| if not self.force_clear and os.path.exists(output_path): | ||
| log_message(f"Reusing existing raster: {output_path}") | ||
| self.output_rasters.append(output_path) | ||
| continue | ||
|
|
||
| log_message(f"Calculating Mask by SCORE by Population for area {index}") | ||
|
|
||
| params = { | ||
| "INPUT_A": mask_layer, | ||
| "BAND_A": 1, | ||
| "INPUT_B": wee_score_by_population_layer, | ||
| "BAND_B": 1, | ||
| "FORMULA": "A * B", | ||
| "NO_DATA": None, | ||
| "EXTENT_OPT": 3, | ||
| "PROJWIN": None, | ||
| "RTYPE": 0, | ||
| "OPTIONS": "", | ||
| "EXTRA": "", | ||
| "OUTPUT": output_path, | ||
| } | ||
|
|
||
| processing.run("gdal:rastercalculator", params) | ||
| self.output_rasters.append(output_path) | ||
|
|
||
| log_message(f"Masked WEE SCORE raster saved to {output_path}") | ||
|
|
||
| def generate_vrt(self) -> None: | ||
| """ | ||
| Combines all WEE SCORE rasters into a single VRT and ap plies a QML style. | ||
| """ | ||
| vrt_path = os.path.join(self.output_dir, "wee_by_opportunities_mask.vrt") | ||
| qml_path = os.path.join(self.output_dir, "wee_by_opportunities_mask.qml") | ||
| source_qml = resources_path("resources", "qml", "wee_by_population_score.qml") | ||
|
|
||
| params = { | ||
| "INPUT": self.output_rasters, | ||
| "RESOLUTION": 0, # Use highest resolution | ||
| "SEPARATE": False, # Combine into a single band | ||
| "OUTPUT": vrt_path, | ||
| } | ||
|
|
||
| processing.run("gdal:buildvirtualraster", params) | ||
| log_message(f"Generated VRT at {vrt_path}") | ||
|
|
||
| # 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( | ||
| "Opportunities mask by WEE SCORE by Population calculation completed successfully." | ||
| ) | ||
| else: | ||
| log_message( | ||
| "Opportunities mask by WEE SCORE by Population calculation failed." | ||
| ) |
Oops, something went wrong.