hydromt_sfincs.components.quadtree.SfincsQuadtreeMask

class hydromt_sfincs.components.quadtree.SfincsQuadtreeMask(model: SfincsModel)

Mask stored in the shared quadtree grid.

data exposes only this component’s mask, retaining the mesh and grid attributes. The parent grid reads and writes the mask in qtrfile.

__init__(model: SfincsModel)

Methods

__init__(model)
clear_overlay()	Invalidate the cached mask-overlay dataframe.
close()	Clean up all open datasets.
create([model, zmin, zmax, include_polygon, ...])	Setup active model mask and add boundaries.
create_active([model, zmin, zmax, ...])	Setup active model cells.
create_boundary([model, btype, zmin, zmax, ...])	Set boundary cells in the model mask.
finish_write()	Finish the write functionality after cleanup was called for all components in the model.
map_overlay(file_name[, xlim, ylim, colors, ...])	Render a PNG mask overlay.
read()	Ensure the parent grid is loaded, including masks in qtrfile.
test_equal(other)	Test if two components are equal.
to_gdf([option])	Returns a geodataframe with points for each cell in the mask
write()	Leave mask persistence in qtrfile to the parent grid.

Attributes

data	Return only this mask, retaining the parent mesh.
data_catalog	Return the data catalog of the model this component is associated with.
empty_mask	Get an empty mask with the same shape as the model grid.
face_coordinates
has_open_boundaries	Returns True if mask contains open boundaries (mask = 2)
model	Return the model object this component is associated with.
name_in_model	Find the name of the component in the parent model components.
root	Return the root of the model this component is associated with.