GreenInfrastructure

objects.GreenInfrastructure()

The expected variables and data types of the “green infrastructure” hazard measure.

Attributes

name : str: Name of the measure.
description : str: Description of the measure.
type : MeasureType: Type of measure. Should be “greening”
selection_type : SelectionType: Type of selection. Should be “polygon” or “aggregation_area”.
height : (us.UnitfulHeight, Optional): Height of the green infrastructure.
volume : (us.UnitfulVolume, Optional): Volume of the green infrastructure.
polygon_file : (str, Optional): Path to a polygon file, either absolute or relative to the measure path.
aggregation_area_type : (str, Optional): Type of aggregation area. Should be “aggregation_area”.
aggregation_area_name : (str, Optional): Name of the aggregation area.
percent_area : (float, Optional): Percentage of the area that is green infrastructure.

Name	Description
calculate_polygon_area	Calculate area of a GeoDataFrame Polygon.
calculate_volume	Determine volume from area of the polygon and infiltration height.

objects.GreenInfrastructure.calculate_polygon_area(
    gdf: gpd.GeoDataFrame,
    site: Site,
)

Calculate area of a GeoDataFrame Polygon.

objects.GreenInfrastructure.calculate_volume(
    area: us.UnitfulArea,
    height: us.UnitfulHeight,
    percent_area: float = 100.0,
)

Determine volume from area of the polygon and infiltration height.

area : us.UnitfulArea: Area of polygon with units (calculated using calculate_polygon_area)
height : us.UnitfulHeight: Water height with units
percent_area : float = 100.0: Percentage area covered by green infrastructure [%], by default 100.0