preprocess.cloudmasking

vhrharmonize.preprocess.cloudmasking

CloudMaskResult dataclass

Summary of cloud mask generation and application.

cloudmask_raster(input_image_path, output_raster_path, output_mask_path, *, red_band_index, green_band_index, nir_band_index, cloud_classes=(1, 2, 3), buffer_pixels=0, omnicloud_kwargs=None, inference_resolution_m=10.0, cloud_mask_value=1, output_nodata_value=None, allow_mask_reprojection=True, log_to_console=False, scene_basename=None)

Create a cloud mask and apply it to a raster.

create_cloud_mask_with_omnicloudmask(input_image_path, output_mask_path, red_band_index, green_band_index, nir_band_index, *, cloud_classes=(1, 2, 3), buffer_pixels=0, omnicloud_kwargs=None, inference_resolution_m=10.0, log_to_console=False, scene_basename=None)

Run OmniCloudMask on an input raster and write a binary cloud mask.

Output mask values: - 1: cloud/cloud-shadow (or buffered cloud zone) - 0: clear

apply_binary_cloud_mask_to_image(input_image_path, cloud_mask_path, output_image_path, *, cloud_mask_value=1, output_nodata_value=None, allow_mask_reprojection=True, log_to_console=False, scene_basename=None)

Apply a binary cloud mask to an image by assigning NoData to masked pixels.