Add validation rules for input rasters

rubem/_dynamic_model.py

@@ -89,7 +89,7 @@ def __stepReport(self):
                 continue
 
             # Export TIFF raster series
-            if self.config.output_variables.file_format is OutputFileFormat.GeoTIFF:
+            if self.config.output_variables.file_format is OutputFileFormat.GEOTIFF:
                 reportTIFFSeries(
                     self,
                     self.ref,
@@ -101,7 +101,7 @@ def __stepReport(self):
                 )
 
             # Export PCRaster map format raster series
-            if self.config.output_variables.file_format is OutputFileFormat.PCRaster:
+            if self.config.output_variables.file_format is OutputFileFormat.PCRASTER:
                 self.report(self.outputVarsDict.get(outputVar), outputVar)
 
             # Check if we have to export the time series of the selected

rubem/configuration/input_raster_files.py

@@ -2,8 +2,10 @@
 import os
 from typing import Union
 
-from rubem.configuration.pcraster_map import PCRasterMap
+from rubem.configuration.raster_map import RasterMap
 from rubem.configuration.data_ranges_settings import DataRangesSettings
+from rubem.validation.raster_data import RasterMapValidator
+from rubem.validation.raster_data_rules import RasterDataRules
 
 
 class InputRasterFiles:
@@ -67,17 +69,46 @@ def __init__(
 
     def __validate_files(self) -> None:
         files = [
-            (self.dem, self.__ranges.rasters["dem"]),
-            (self.demtif, self.__ranges.rasters["dem"]),
-            (self.clone, self.__ranges.rasters["clone"]),
-            (self.ndvi_max, self.__ranges.rasters["ndvi"]),
-            (self.ndvi_min, self.__ranges.rasters["ndvi"]),
-            (self.soil, self.__ranges.rasters["soil"]),
-            (self.sample_locations, self.__ranges.rasters["sample_locations"]),
+            (
+                self.dem,
+                self.__ranges.rasters["dem"],
+                RasterDataRules.FORBID_NO_DATA
+                | RasterDataRules.FORBID_ALL_ZEROES
+                | RasterDataRules.FORBID_ALL_ONES,
+            ),
+            (
+                self.demtif,
+                self.__ranges.rasters["dem"],
+                RasterDataRules.FORBID_NO_DATA
+                | RasterDataRules.FORBID_ALL_ZEROES
+                | RasterDataRules.FORBID_ALL_ONES,
+            ),
+            (self.clone, self.__ranges.rasters["clone"], RasterDataRules.FORBID_ALL_ZEROES),
+            (self.ndvi_max, self.__ranges.rasters["ndvi"], RasterDataRules.FORBID_NO_DATA),
+            (self.ndvi_min, self.__ranges.rasters["ndvi"], RasterDataRules.FORBID_NO_DATA),
+            (
+                self.soil,
+                self.__ranges.rasters["soil"],
+                RasterDataRules.FORBID_NO_DATA | RasterDataRules.FORBID_ALL_ZEROES,
+            ),
+            (
+                self.sample_locations,
+                self.__ranges.rasters["sample_locations"],
+                RasterDataRules.FORBID_ALL_ZEROES | RasterDataRules.FORBID_ALL_ONES,
+            ),
         ]
 
-        for file, valid_range in files:
-            _ = PCRasterMap(file, valid_range)
+        for file, valid_range, rules in files:
+            raster = RasterMap(file, valid_range, rules)
+            self.logger.debug(str(raster).replace("\n", ", "))
+
+            validator = RasterMapValidator()
+            if not validator.validate(raster):
+                self.logger.error(
+                    "Raster file '%s' contains invalid data. This may lead to unexpected results.",
+                    file,
+                )
+                raise ValueError(f"Raster file '{file}' contains invalid data.")
 
     def __str__(self) -> str:
         return (

rubem/configuration/input_raster_series.py

@@ -3,8 +3,10 @@
 from typing import Union
 import re
 
-from rubem.configuration.pcraster_map import PCRasterMap
+from rubem.configuration.raster_map import RasterMap
 from rubem.configuration.data_ranges_settings import DataRangesSettings
+from rubem.validation.raster_data import RasterMapValidator
+from rubem.validation.raster_data_rules import RasterDataRules
 
 RASTER_SERIES_FILENAME_MAX_CHARS = 8
 RASTER_SERIES_FILENAME_EXTENSION_NUM_DIGITS = 3
@@ -95,23 +97,40 @@ def __init__(
 
     def __validate_directories(self) -> None:
         directories = [
-            (self.__etp_dir_path, self.__etp_filename_prefix, self.__ranges.rasters["etp"]),
+            (
+                self.__etp_dir_path,
+                self.__etp_filename_prefix,
+                self.__ranges.rasters["etp"],
+                RasterDataRules.FORBID_NO_DATA,
+            ),
             (
                 self.__precipitation_dir_path,
                 self.__precipitation_filename_prefix,
                 self.__ranges.rasters["precipitation"],
+                RasterDataRules.FORBID_NO_DATA,
+            ),
+            (
+                self.__ndvi_dir_path,
+                self.__ndvi_filename_prefix,
+                self.__ranges.rasters["ndvi"],
+                RasterDataRules.FORBID_NO_DATA,
+            ),
+            (
+                self.__kp_dir_path,
+                self.__kp_filename_prefix,
+                self.__ranges.rasters["kp"],
+                RasterDataRules.FORBID_NO_DATA,
             ),
-            (self.__ndvi_dir_path, self.__ndvi_filename_prefix, self.__ranges.rasters["ndvi"]),
-            (self.__kp_dir_path, self.__kp_filename_prefix, self.__ranges.rasters["kp"]),
             (
                 self.__landuse_dir_path,
                 self.__landuse_filename_prefix,
                 self.__ranges.rasters["landuse"],
+                RasterDataRules.FORBID_NO_DATA | RasterDataRules.FORBID_ALL_ZEROES,
             ),
         ]
 
         total_num_files = []
-        for directory, prefix, valid_range in directories:
+        for directory, prefix, valid_range, rules in directories:
             if not os.path.isdir(directory):
                 raise NotADirectoryError(f"Invalid input data directory: {directory}")
 
@@ -120,7 +139,7 @@ def __validate_directories(self) -> None:
 
             self.__validate_raster_series_filenames_prefixes(prefix)
             total_num_files.append(
-                self.__validate_files_with_prefix(directory, prefix, valid_range)
+                self.__validate_files_with_prefix(directory, prefix, valid_range, rules)
             )
 
         common_total_num_files = set(total_num_files)
@@ -130,7 +149,7 @@ def __validate_directories(self) -> None:
                 "This may lead to unexpected results."
             )
 
-    def __validate_files_with_prefix(self, directory, prefix, valid_range) -> int:
+    def __validate_files_with_prefix(self, directory, prefix, valid_range, rules) -> int:
         num_digits = RASTER_SERIES_FILENAME_MAX_CHARS - len(prefix)
         regex_pattern = rf"^{prefix}[0-9]{{{num_digits}}}\.[0-9]{{{RASTER_SERIES_FILENAME_EXTENSION_NUM_DIGITS}}}$"
         compiled_pattern = re.compile(regex_pattern, re.IGNORECASE)
@@ -139,7 +158,7 @@ def __validate_files_with_prefix(self, directory, prefix, valid_range) -> int:
         with os.scandir(directory) as it:
             for entry in it:
                 if entry.is_file() and compiled_pattern.match(entry.name):
-                    self.__validate_raster_file(entry.path, valid_range)
+                    self.__validate_raster_file(entry.path, valid_range, rules)
                     counter += 1
 
         if counter == 0:
@@ -159,8 +178,17 @@ def __validate_files_with_prefix(self, directory, prefix, valid_range) -> int:
 
         return counter
 
-    def __validate_raster_file(self, file, valid_range) -> None:
-        _ = PCRasterMap(file, valid_range)
+    def __validate_raster_file(self, file, valid_range, rules) -> None:
+        raster = RasterMap(file, valid_range, rules)
+        self.logger.debug(str(raster).replace("\n", ", "))
+
+        validator = RasterMapValidator()
+        if not validator.validate(raster):
+            self.logger.error(
+                "Raster file '%s' contains invalid data. This may lead to unexpected results.",
+                file,
+            )
+            raise ValueError(f"Raster file '{file}' contains invalid data.")
 
     def __validate_raster_series_filenames_prefixes(self, prefix):
         num_digits = RASTER_SERIES_FILENAME_MAX_CHARS - len(prefix)

rubem/configuration/model_configuration.py

@@ -112,9 +112,9 @@ def __init__(
                 rnf=bool(self.__get_setting("GENERATE_FILE", "rnf")),
                 tss=bool(self.__get_setting("GENERATE_FILE", "tss")),
                 output_format=(
-                    OutputFileFormat.PCRaster
+                    OutputFileFormat.PCRASTER
                     if bool(self.__get_setting("RASTER_FILE_FORMAT", "map_raster_series"))
-                    else OutputFileFormat.GeoTIFF
+                    else OutputFileFormat.GEOTIFF
                 ),
             )
             self.raster_series = InputRasterSeries(

rubem/configuration/output_format.py

@@ -1,10 +1,10 @@
-from enum import Enum
+from enum import Enum, auto
 
 
 class OutputFileFormat(Enum):
     """
     Enum class representing the output file format options.
     """
 
-    PCRaster = 1
-    GeoTIFF = 2
+    PCRASTER = auto()
+    GEOTIFF = auto()

rubem/configuration/output_variables.py

@@ -34,7 +34,7 @@ class OutputVariables:
     :param tss: Enable or disable Create time output time series (TSS). Defaults to `False`.
     :type tss: bool, optional
 
-    :param output_format: The output file format. Defaults to `OutputFileFormat.PCRaster`.
+    :param output_format: The output file format. Defaults to ``OutputFileFormat.PCRASTER``.
     :type output_format: OutputFileFormat, optional
     """
 
@@ -49,7 +49,7 @@ def __init__(
         smc: bool = False,
         rnf: bool = False,
         tss: bool = False,
-        output_format: OutputFileFormat = OutputFileFormat.PCRaster,
+        output_format: OutputFileFormat = OutputFileFormat.PCRASTER,
     ) -> None:
         self.logger = logging.getLogger(__name__)
         self.itp = itp