hydromt_sfincs.components.geometries.SfincsObservationPoints

class hydromt_sfincs.components.geometries.SfincsObservationPoints(model: SfincsModel)

SFINCS Observation Points Component.

This component handles reading, writing, and creating observation points, which are used for extracting model results at specific locations such as water level gauging stations. The frequency of output at these points can be controlled via the “dthisout” parameter in the configuration.

__init__(model: SfincsModel)

Methods

__init__(model)
add_point(x, y, name)	Add single point to observation points.
clear()	Clean GeoDataFrame with observation points.
close()	Clean up all open datasets.
create(locations[, merge])	Create model observation point locations.
delete(index)	Remove one or more observation points.
delete_point(name_or_index)	Remove point from observation points.
finish_write()	Finish the write functionality after cleanup was called for all components in the model.
list_names()	Give list of names of observation points.
read([filename])	Read SFINCS observation points (.obs) file.
set(gdf[, merge])	Set SFINCS observation points.
test_equal(other)	Test if two components are equal.
write([filename])	Write SFINCS observation points (.obs) file, and set obsfile in config (if it was not already set)

Attributes

data	Observation point data, returned as a GeoDataFrame.
data_catalog	Return the data catalog of the model this component is associated with.
model	Return the model object this component is associated with.
name_in_model	Find the name of the component in the parent model components.
nr_points	Return the number of point locations currently stored.
root	Return the root of the model this component is associated with.