rubem.configuration.input_raster_files.InputRasterFiles

class InputRasterFiles(**data)[source]

Bases: BaseModel

Represents a collection of input raster files used in RUBEM analysis.

Parameters:

  • dem – Path to the DEM file (*.map format).

  • clone – Path to the mask of catchment (clone) file.

  • ndvi_max – Path to the NDVI maximum file.

  • ndvi_min – Path to the NDVI minimum file.

  • soil – Path to the soil file.

  • sample_locations – Path to the stations locations (samples) file. Specifies a nominal map with unique IDs for which sampling point(s) the time series(s) are required. Defaults to None.

  • ldd – Path to the Local Drain Direction (LDD) raster file. Defaults to None.

  • georeference – Path to a raster whose coordinate reference system is written to the output GeoTIFF series. Must share the DEM geometry. Defaults to None.

  • zones – Path to a nominal raster of zones the time series may be averaged over. Defaults to None.

  • validate_input – If True, validates the content of the input raster files. Defaults to True.

Raises:

  • FileNotFoundError – If any of the input raster files does not exist.

  • ValueError – If any of the input raster files is empty or has an invalid extension.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

Attributes

problems

Non-blocking data problems found while validating the rasters.

dem

clone

ndvi_max

ndvi_min

soil

sample_locations

ldd

georeference

zones

validate_input

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialize private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Return type:

None

Parameters:

  • self – The BaseModel instance.

  • context – The context.

property problems: list[Problem]

Non-blocking data problems found while validating the rasters.