hydromt_fiat.components.HazardComponent.clip#

HazardComponent.clip(geom: GeoDataFrame, buffer: int = 0, inplace: bool = False) → Dataset | None[source]#

Clip the hazard data based on geometry.

Parameters:

  • geom (gpd.GeoDataFrame) – The area to clip the data to.

  • buffer (int, optional) – A buffer of cells around the clipped area to keep, by default 0.

  • inplace (bool, optional) – Whether to do the clipping in place or return a new xr.Dataset, by default False.

Returns:

Return a dataset if the inplace is False.

Return type:

xr.Dataset | None