dbs_classes.dbs_static.DbsStatic
dbs_classes.dbs_static.DbsStatic(self, database)Methods
| Name | Description |
|---|---|
| get_aggregation_areas | Get a list of the aggregation areas that are provided in the site configuration. |
| get_buildings | Get the building footprints from the FIAT model. |
| get_fiat_model | Get the path to the FIAT model. |
| get_green_infra_table | Return a table with different types of green infrastructure measures and their infiltration depths. |
| get_model_boundary | Get the model boundary from the SFINCS model. |
| get_model_grid | Get the model grid from the SFINCS model. |
| get_obs_points | Get the observation points from the flood hazard model. |
| get_offshore_sfincs_model | Get the template overland Sfincs model. |
| get_overland_sfincs_model | Get the template offshore SFINCS model. |
| get_property_types | summary. |
| get_slr_scn_names | Get the names of the sea level rise scenarios from the file provided. |
| get_static_map | Get a map from the static folder. |
get_aggregation_areas
dbs_classes.dbs_static.DbsStatic.get_aggregation_areas()Get a list of the aggregation areas that are provided in the site configuration.
These are expected to much the ones in the FIAT model.
Returns
| Name | Type | Description |
|---|---|---|
| list[gpd.GeoDataFrame] | list of gpd.GeoDataFrames with the polygons defining the aggregation areas |
get_buildings
dbs_classes.dbs_static.DbsStatic.get_buildings()Get the building footprints from the FIAT model.
This should only be the buildings excluding any other types (e.g., roads) The parameters non_building_names in the site config is used for that.
Returns
| Name | Type | Description |
|---|---|---|
| gpd.GeoDataFrame | building footprints with all the FIAT columns |
get_fiat_model
dbs_classes.dbs_static.DbsStatic.get_fiat_model()Get the path to the FIAT model.
get_green_infra_table
dbs_classes.dbs_static.DbsStatic.get_green_infra_table(measure_type)Return a table with different types of green infrastructure measures and their infiltration depths.
This is read by a csv file in the database.
Returns
| Name | Type | Description |
|---|---|---|
| pd.DataFrame | Table with values |
get_model_boundary
dbs_classes.dbs_static.DbsStatic.get_model_boundary()Get the model boundary from the SFINCS model.
get_model_grid
dbs_classes.dbs_static.DbsStatic.get_model_grid()Get the model grid from the SFINCS model.
Returns
| Name | Type | Description |
|---|---|---|
| QuadtreeGrid | The model grid |
get_obs_points
dbs_classes.dbs_static.DbsStatic.get_obs_points()Get the observation points from the flood hazard model.
get_offshore_sfincs_model
dbs_classes.dbs_static.DbsStatic.get_offshore_sfincs_model()Get the template overland Sfincs model.
get_overland_sfincs_model
dbs_classes.dbs_static.DbsStatic.get_overland_sfincs_model()Get the template offshore SFINCS model.
get_property_types
dbs_classes.dbs_static.DbsStatic.get_property_types()summary.
Returns
| Name | Type | Description |
|---|---|---|
| list | description |
get_slr_scn_names
dbs_classes.dbs_static.DbsStatic.get_slr_scn_names()Get the names of the sea level rise scenarios from the file provided.
Returns
| Name | Type | Description |
|---|---|---|
| list | List of scenario names |
get_static_map
dbs_classes.dbs_static.DbsStatic.get_static_map(path)Get a map from the static folder.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| path | Union[str, Path] | Path to the map relative to the static folder | required |
Returns
| Name | Type | Description |
|---|---|---|
| gpd.GeoDataFrame | gpd.GeoDataFrame with the map in crs 4326 |
Raises
| Name | Type | Description |
|---|---|---|
| FileNotFoundError | If the file is not found |