hydromt_fiat.components.ExposureGeomsComponent.setup#

ExposureGeomsComponent.setup(exposure_fname: Path | str, exposure_type_column: str, *, exposure_link_fname: Path | str | None = None, exposure_type_fill: str | None = None, predicate: str = 'contains', link_to_vulnerability: bool = True) → None[source]#

Set up the exposure from a data source.

Will link with the vulnerability data to set a curve for each exposure type.

Warning

Run setup_vulnerability beforehand (see vulnerability component).

Parameters:

  • exposure_fname (Path | str) – The name of/ path to the raw exposure dataset.

  • exposure_type_column (str) – The name of column in the raw dataset that specifies the object type, e.g. the occupancy type.

  • exposure_link_fname (Path | str | None, optional) – The name of/ path to the dataset containing the mapping of the exposure types to the vulnerability data, by default None.

  • exposure_type_fill (str, optional) – Value to which missing entries in the exposure type column will be mapped to, if provided. By default None.

  • predicate (str, optional) – Method on how to select the data that falls within the region geometry. For more information see geopandas.sjoin. By default ‘contains’.

  • link_to_vulnerability (bool, optional) – Whether to already link to the vulnerability in this setup method. By default False.