api.static
api.static
Functions
| Name | Description |
|---|---|
| get_aggregation_areas | Get a list of the aggregation areas that are provided in the site configuration. |
| get_buildings | Get the buildings exposure that are used in Fiat. |
| get_event_templates | Get list of all implemented event templates. |
| get_hazard_measure_types | Get list of all implemented hazard measure types. |
| get_impact_measure_types | Get list of all implemented impact measure types. |
| get_model_boundary | Get the model boundary that is used in SFINCS. |
| get_model_grid | Get the model grid that is used in SFINCS. |
| get_obs_points | Get the observation points specified in the site.toml. |
| get_property_types | Get the property types that are used in the exposure. |
| get_static_map | Get a static map from the database. |
| get_svi_map | Get the SVI map that are used in Fiat. |
| read_database | Given a path and a site name returns a IDatabase object. |
get_aggregation_areas
api.static.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 |
|---|---|---|
| dict[str, GeoDataFrame] | list of geodataframes with the polygons defining the aggregation areas |
get_buildings
api.static.get_buildings()Get the buildings exposure that are used in Fiat.
Returns
| Name | Type | Description |
|---|---|---|
| GeoDataFrame | GeoDataFrames with the buildings from FIAT exposure |
get_event_templates
api.static.get_event_templates()Get list of all implemented event templates.
get_hazard_measure_types
api.static.get_hazard_measure_types()Get list of all implemented hazard measure types.
get_impact_measure_types
api.static.get_impact_measure_types()Get list of all implemented impact measure types.
get_model_boundary
api.static.get_model_boundary()Get the model boundary that is used in SFINCS.
Returns
| Name | Type | Description |
|---|---|---|
| GeoDataFrame | GeoDataFrame with the model boundary |
get_model_grid
api.static.get_model_grid()Get the model grid that is used in SFINCS.
Returns
| Name | Type | Description |
|---|---|---|
| QuadtreeGrid | QuadtreeGrid with the model grid |
get_obs_points
api.static.get_obs_points()Get the observation points specified in the site.toml.
These are also added to the flood hazard model. They are used as marker locations to plot water level time series in the output tab.
Returns
| Name | Type | Description |
|---|---|---|
| GeoDataFrame | GeoDataFrame with observation points from the site.toml. |
get_property_types
api.static.get_property_types()Get the property types that are used in the exposure.
Returns
| Name | Type | Description |
|---|---|---|
| list | list of property types |
get_static_map
api.static.get_static_map(path)Get a static map from the database.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| path | Union[str, Path] | path to the static map | required |
Returns
| Name | Type | Description |
|---|---|---|
| gpd.GeoDataFrame | GeoDataFrame with the static map |
get_svi_map
api.static.get_svi_map()Get the SVI map that are used in Fiat.
Returns
| Name | Type | Description |
|---|---|---|
| GeoDataFrame | GeoDataFrames with the SVI map, None if not available |
read_database
api.static.read_database(database_path, site_name)Given a path and a site name returns a IDatabase object.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| database_path | Union[str, os.PathLike] | path to database | required |
| site_name | str | name of the site | required |
Returns
| Name | Type | Description |
|---|---|---|
| IDatabase |