-
Notifications
You must be signed in to change notification settings - Fork 0
static
Sam Vente edited this page Aug 6, 2024
·
1 revision
``
| Name | Description |
|---|---|
| get_aggregation_areas | Get the aggregations areas that are used for the site and fiat. |
| get_buildings | Get the buildings exposure that are used in Fiat. |
| get_event_templates | |
| get_hazard_measure_types | |
| get_impact_measure_types | |
| get_model_boundary | |
| 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_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()
Get the aggregations areas that are used for the site and fiat.
| Name | Type | Description | Default |
|---|---|---|---|
database |
IDatabase | required |
| Type | Description |
|---|---|
| list[GeoDataFrame] | list of GeoDataFrames with the aggregation areas |
get_buildings()
Get the buildings exposure that are used in Fiat.
| Name | Type | Description | Default |
|---|---|---|---|
database |
IDatabase | required |
| Type | Description |
|---|---|
| GeoDataFrame | GeoDataFrames with the buildings from FIAT exposure |
get_event_templates()
get_hazard_measure_types()
get_impact_measure_types()
get_model_boundary()
get_model_grid()
Get the model grid that is used in SFINCS.
| Name | Type | Description | Default |
|---|---|---|---|
database |
IDatabase | required |
| Type | Description |
|---|---|
| QuadtreeGrid | QuadtreeGrid with the model grid |
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.
| Name | Type | Description | Default |
|---|---|---|---|
database |
IDatabase | required |
| Type | Description |
|---|---|
| GeoDataFrame | GeoDataFrame with observation points from the site.toml. |
get_property_types()
get_static_map(path)
Get a static map from the database.
| Name | Type | Description | Default |
|---|---|---|---|
database |
IDatabase | database object | required |
path |
Union[str, Path] | path to the static map | required |
| Type | Description |
|---|---|
| gpd.GeoDataFrame | GeoDataFrame with the static map |
get_svi_map()
Get the SVI map that are used in Fiat.
| Name | Type | Description | Default |
|---|---|---|---|
database |
IDatabase | required |
| Type | Description |
|---|---|
| GeoDataFrame | GeoDataFrames with the SVI map, None if not available |
read_database(database_path, site_name)
Given a path and a site name returns a IDatabase object.
| Name | Type | Description | Default |
|---|---|---|---|
database_path |
Union[str, os.PathLike] | path to database | required |
site_name |
str | name of the site | required |
| Type | Description |
|---|---|
| IDatabase |