hydromt_sfincs.components.quadtree.SnapWaveQuadtreeMask.create#

SnapWaveQuadtreeMask.create(model: str = 'snapwave', zmin: float = None, zmax: float = None, include_polygon: str | Path | GeoDataFrame = None, include_zmin: float = None, include_zmax: float = None, exclude_polygon: str | Path | GeoDataFrame = None, exclude_zmin: float = None, exclude_zmax: float = None, open_boundary_polygon: str | Path | GeoDataFrame = None, open_boundary_zmin: float = None, open_boundary_zmax: float = None, neumann_boundary_polygon: str | Path | GeoDataFrame = None, neumann_boundary_zmin: float = None, neumann_boundary_zmax: float = None, all_touched: bool = False)[source]#

Setup active model snapwave mask and add boundaries. Note that boundary types can only be set when polygons are provided.

Parameters:

  • model (str, optional) – Model type, either ‘sfincs’ (default) or ‘snapwave’, for which the mask will be created.

  • zmin (float, optional) – Minimum and maximum elevation thresholds for active model cells.

  • zmax (float, optional) – Minimum and maximum elevation thresholds for active model cells.

  • include_polygon (str, Path, gpd.GeoDataFrame, optional) – Path or data source name of polygons to include/exclude from the active model domain. Note that include (second last) and exclude (last) areas are processed after other critera, i.e. zmin, zmax and thus overrule these criteria for active model cells.

  • exclude_polygon (str, Path, gpd.GeoDataFrame, optional) – Path or data source name of polygons to include/exclude from the active model domain. Note that include (second last) and exclude (last) areas are processed after other critera, i.e. zmin, zmax and thus overrule these criteria for active model cells.

  • include_zmin (float, optional) – Minimum and maximum elevation thresholds for included model cells.

  • include_zmax (float, optional) – Minimum and maximum elevation thresholds for included model cells.

  • exclude_zmin (float, optional) – Minimum and maximum elevation thresholds for excluded model cells.

  • exclude_zmax (float, optional) – Minimum and maximum elevation thresholds for excluded model cells.

  • open_boundary_polygon (str, Path, gpd.GeoDataFrame, optional) – Path or data source name for geometries with areas to include as open boundary or neumann boundary. For each polygon, also the minimum and maximum elevation thresholds can be specified using the corresponding *_zmin and *_zmax arguments.

  • neumann_boundary_polygon (str, Path, gpd.GeoDataFrame, optional) – Path or data source name for geometries with areas to include as open boundary or neumann boundary. For each polygon, also the minimum and maximum elevation thresholds can be specified using the corresponding *_zmin and *_zmax arguments.

  • also (See)

  • ---------

  • cells (* create_active method to setup active model)

  • type (* create_boundary method to setup boundary cells of a specific)

On this page