hydromt.data_catalog.adapters.GeoDataFrameAdapter#

pydantic model hydromt.data_catalog.adapters.GeoDataFrameAdapter[source]#

The GeoDataFrameAdapter performs transformations on GeoDataFrames.

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.

transform(gdf: GeoDataFrame, metadata: SourceMetadata, *, mask: GeoDataFrame | None = None, variables: List[str] | None = None, predicate: str = 'intersects', handle_nodata: NoDataStrategy = NoDataStrategy.RAISE) → GeoDataFrame | None[source]#

Read transform data to HydroMT standards.

Parameters:

  • gdf (gpd.GeoDataFrame) – input GeoDataFrame

  • metadata (SourceMetadata) – source metadata

  • mask (Optional[gpd.GeoDataFrame], optional) – mask to filter by geometry, by default None

  • variables (Optional[List[str]], optional) – variable filter, by default None

  • predicate (str, optional) – predicate to use for the mask filter, by default “intersects”

  • handle_nodata (NoDataStrategy, optional) – how to handle no data being present in the result, by default NoDataStrategy.RAISE

Returns:

filtered and harmonized GeoDataFrame

Return type:

Optional[gpd.GeoDataFrame]

Raises:

  • ValueError – if not all variables are found in the data

  • NoDataException – if no data in left after slicing and handle_nodata is NoDataStrategy.RAISE