+
+
Aggregates raster values to polygons in a shapefile, optionally using a crop mask for weighted calculations.
+
+
Parameters:
+
+
+
+ | Name |
+ Type |
+ Description |
+ Default |
+
+
+
+
+ predictor_dir |
+ str |
+ Directory containing raster datasets. |
+ required |
+
+
+ shapefile_path |
+ str |
+ Path to the shapefile with polygons for aggregation. |
+ required |
+
+
+ output_csv_path |
+ str |
+ Path where the aggregated output CSV will be saved. |
+ required |
+
+
+ crop_mask_path |
+ str |
+ Path to the crop mask raster, required if use_crop_mask is True. |
+ required |
+
+
+ use_crop_mask |
+ bool |
+ Whether to use the crop mask for weighted aggregation. |
+ required |
+
+
+ predictor_name |
+ str |
+ Column name for the aggregated values in the output CSV. |
+ 'Value' |
+
+
+
+
Exceptions:
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ ValueError |
+ If use_crop_mask is True but crop_mask_path is not provided. |
+
+
+
Aggregates values from each raster within the specified directory to each polygon in the shapefile,
+writing the results to a CSV file. If a crop mask is used, values are aggregated using weights from
+the mask; otherwise, simple averaging is applied.
+
+
+ Source code in earthstat/analysis_aggregation/aggregate_process.py
+ def conAggregate(
+
+ predictor_dir,
+ shapefile_path,
+ output_csv_path,
+ mask_path=None,
+ use_mask=False,
+ invalid_values=None,
+ calculation_mode="overall_mean",
+ predictor_name="Value",
+ all_touched=False
+):
+ """
+ Aggregates raster values to polygons in a shapefile, optionally using a crop mask for weighted calculations.
+
+ Args:
+ predictor_dir (str): Directory containing raster datasets.
+ shapefile_path (str): Path to the shapefile with polygons for aggregation.
+ output_csv_path (str): Path where the aggregated output CSV will be saved.
+ crop_mask_path (str, optional): Path to the crop mask raster, required if use_crop_mask is True.
+ use_crop_mask (bool): Whether to use the crop mask for weighted aggregation.
+ predictor_name (str): Column name for the aggregated values in the output CSV.
+
+ Raises:
+ ValueError: If use_crop_mask is True but crop_mask_path is not provided.
+
+ Aggregates values from each raster within the specified directory to each polygon in the shapefile,
+ writing the results to a CSV file. If a crop mask is used, values are aggregated using weights from
+ the mask; otherwise, simple averaging is applied.
+ """
+ predictor_paths = loadTiff(predictor_dir)
+ data_list = []
+
+ shape_file = gpd.read_file(shapefile_path)
+
+ if use_mask and not mask_path:
+ raise ValueError("Mask path must be provided if use_mask is True.")
+
+ for raster_path in tqdm(predictor_paths, desc="Processing rasters", unit="raster"):
+
+ # Directly call the processing function for each raster
+ data = process_and_aggregate_raster(
+
+ raster_path,
+ shape_file,
+ invalid_values,
+ use_mask,
+ mask_path,
+ calculation_mode,
+ predictor_name,
+ all_touched
+ )
+
+ data_list.extend(data)
+
+ df = pd.DataFrame(data_list)
+ df[predictor_name] = df[predictor_name].round(3)
+ df.to_csv(output_csv_path, index=False)
+
+