hydromt_fiat.fiat.FiatModel.setup_exposure_buildings#

FiatModel.setup_exposure_buildings(asset_locations: str | Path, occupancy_type: str | Path, max_potential_damage: str | Path, ground_floor_height: int | float | str | Path | None, length_unit: Units | None = None, gfh_unit: Units | None = None, gfh_attribute_name: str | None = None, occupancy_attr: str | None = None, occupancy_object_type: List[str] | str | None = None, extraction_method: str = 'centroid', damage_types: List[str] = ['structure', 'content'], damage_unit: Currency = '$', country: str | None = None, ground_elevation: int | float | str | Path | None = None, grnd_elev_unit: Units | None = None, bf_conversion: bool = False, keep_unclassified: bool = True, dst_crs: str | None = None, damage_translation_fn: Path | str | None = None) → None[source]#

Setup building exposure (vector) data for Delft-FIAT.

Parameters:

  • asset_locations (Union[str, Path]) – The path to the vector data (points or polygons) that can be used for the asset locations.

  • occupancy_type (Union[str, Path]) – The path to the data that can be used for the occupancy type.

  • max_potential_damage (Union[str, Path]) – The path to the data that can be used for the maximum potential damage.

  • ground_floor_height (Union[int, float, str, Path None]) – Either a number (int or float), to give all assets the same ground floor height or a path to the data that can be used to add the ground floor height to the assets.

  • length_unit (Units) – The unit of the model

  • gfh_unit (Units) – The unit of the ground_floor_height

  • gfh_attribute_name (str) – The attribute name to be used to set the ground_flht. If None, the attribute name will be set to ‘ground_floor_height’.

  • occupancy_attr (Union[str, None], optional) – The name of the field in the occupancy type data that contains the occupancy type, by default None (this means that the occupancy type data only contains one column with the occupancy type).

  • extraction_method (str, optional) – The method that should be used to extract the hazard values from the hazard maps, by default “centroid”.

  • damage_types (Union[List[str], None], optional) – The damage types that should be used for the exposure data, by default [“structure”, “content”]. The damage types are used to link the vulnerability functions to the exposure data.

  • damage_unit (Currency, optional) – The currency/unit of the Damage data, default in USD $

  • country (Union[str, None], optional) – The country that is used for the exposure data, by default None. This is only required when using the JRC vulnerability curves.

  • ground_elevation (Union[int, float, str, Path None]) – Either a number (int or float), to give all assets the same ground elevation or a path to the data that can be used to add the elevation to the assets.

  • grnd_elev_unit (Units) – The unit of the ground_elevation

  • bf_conversion (bool, optional) – If building footprints shall be converted into point data.

  • keep_unclassified (bool, optional) – Whether building footprints without classification are removed or reclassified as “residential”

  • dst_crs (Union[str, None], optional) – The destination crs of the exposure geometries. if not provided, it is taken from the region attribute of FiatModel. By default None

  • damage_translation_fn (Union[Path, str], optional) – The path to the translation function that can be used to relate user damage curves with user damages.