acept.buildings_information

Module for adding and calculating information about the buildings in a GeoDataFrame.

Use this module to add fields to a GeoDataFrame containing the buildings or calculating the shape around the buildings.

The following fields are calculated and added to the GeoDataFrame:

• bid: consecutive building number as ID

• area: polygon area in m2

• free_walls: free walls of the building, max: 4 walls

• lat: latitude of the centroid in degrees

• lon: longitude of the centroid in degrees

• dist2hp: distance to the heat plant or a heat source in meters

• construction: the class of the year of construction based on the Zensus data

• year_class: the class of the year of construction based on the Zensus data as a numerical value

• building_type: the typology of the building based on the Zensus data

• size_class: the typology of the building based on the Zensus data as a numerical value

• floors: the number of floors in the building

• occupants: the number of occupants in the building

• dwellings: the number of dwellings in the building

• refurb_level_roof: the level of refurbishment of the roof (0, 1, or 2)

• refurb_level_wall: the level of refurbishment of the walls (0, 1, or 2)

• refurb_level_floor: the level of refurbishment of the floor (0, 1, or 2)

• refurb_level_window: the level of refurbishment of the windows (0, 1, or 2)

If the input GeoDataFrame already contains these fields, they will not be added them again. If there are fields with similar names as the calculated ones, the existing fields will be renamed to the expected names. If values are then still missing, they are calculated where possible.

Module Contents

Functions

calculate_missing_uhp_building_fields(...)	Calculates missing fields that are input to UrbanHeatPro.
calculate_bid(buildings)	Adds field "bid" with a consecutive building number as id to the buildings GeoDataFrame.
calculate_areas(buildings)	Adds field "area" with the polygon area in m2 to the buildings GeoDataFrame or reuses the field footprint_area if it
calculate_free_walls(buildings)	Adds field "free_walls" with the number of walls in direct contact with ambient temperature.
calculate_lat_lon(buildings)	Adds field "lat" and "lot" with the latitude and longitude values of the building centroid in degrees.
calculate_distance2hp(buildings[, default_value, ...])	Adds field "dist2hp" with the distance between building and heat plant.
calculate_construction(buildings)	Adds field "construction" with the construction year of the building or renames it if there already exists a field
calculate_year_class_from_construction(buildings)	Adds field "year_class" with the numerical year class of the construction year class. This is the classification
calculate_building_type(buildings)	Adds field "building_type" with the building type, or renames it if there already exists a field named "type",
calculate_size_class(buildings)	Adds field "size_class" with the numerical size class corresponding to the building type. This classification
initialize_floors(buildings)	Adds the empty field "floor" with the number of floors in the building.
initialize_occupants(buildings)	Adds the empty field "occupants" with the number of occupants in the building.
initialize_dwellings(buildings)	Adds the empty field "dwellings" with the number of dwellings in the building. If there is already a field named
initialize_ref_level(buildings, feature_name[, ...])	Adds the field "ref_level_{feature_name}" with the reference level for the given feature.
calculate_shape_around_buildings(→ geopandas.GeoDataFrame)	Calculate the shape around buildings in a GeoDataFrame.

acept.buildings_information.calculate_missing_uhp_building_fields(buildings: geopandas.GeoDataFrame, debug: bool = True) → tuple[geopandas.GeoDataFrame, bool]

Calculates missing fields that are input to UrbanHeatPro.

These are: bid, area, free_walls, lat, lon, dist2hp, construction, year_class, building_type, size_class, floors, occupants, dwellings, and the refurbishment levels.

Parameters:

• buildings (geopandas.GeoDataFrame) – GeoDataFrame containing the buildings

• debug (bool) – Prints debug messages if True (default).

Returns:

GeoDataFrame containing the buildings with missing fields added, and a flag indicating if any fields were added.

Return type:

tuple[geopandas.GeoDataFrame, bool]

acept.buildings_information.calculate_bid(buildings: geopandas.GeoDataFrame)

Adds field “bid” with a consecutive building number as id to the buildings GeoDataFrame.

Parameters:

buildings (geopandas.GeoDataFrame) – GeoDataFrame containing buildings.

acept.buildings_information.calculate_areas(buildings: geopandas.GeoDataFrame)

Adds field “area” with the polygon area in m2 to the buildings GeoDataFrame or reuses the field footprint_area if it exists.

Parameters:

buildings (geopandas.GeoDataFrame) – GeoDataFrame containing buildings.

acept.buildings_information.calculate_free_walls(buildings: geopandas.GeoDataFrame)

Adds field “free_walls” with the number of walls in direct contact with ambient temperature.

It is assumed that all buildings have only four walls.

Parameters:

buildings (geopandas.GeoDataFrame) – GeoDataFrame containing buildings.

acept.buildings_information.calculate_lat_lon(buildings: geopandas.GeoDataFrame)

Adds field “lat” and “lot” with the latitude and longitude values of the building centroid in degrees.

If the (user defined fields) ‘user_lat’ and ‘user_lon’ exist, they are used

Parameters:

buildings (geopandas.GeoDataFrame) – GeoDataFrame containing buildings.

acept.buildings_information.calculate_distance2hp(buildings: geopandas.GeoDataFrame, default_value: int | float = 0, path_to_heat_plant_file: str | None = None, position_index_of_heat_plant: int = 0)

Adds field “dist2hp” with the distance between building and heat plant.

This can be done via the location of the heat plant (see shapefile) or if there is a user-defined distance in the field “user_dist_to_heat_source”, this is used. If no heat plant is given and the field “user_dist_to_heat_source” does not exist or is empty, the default value is used. The heat plant location is given in a shapefile.

Parameters:

• buildings (geopandas.GeoDataFrame) – GeoDataFrame containing buildings.

• default_value (int | float) – Default distance to be used if the heat plant file or the specified index in it does not exist. Default: 0.

• path_to_heat_plant_file (str | None) – Path to the shapefile containing the heat plant. If None, the default value is used.

• position_index_of_heat_plant (int) – Index of the heat plant in the shapefile. Default: 0

acept.buildings_information.calculate_construction(buildings: geopandas.GeoDataFrame)

Adds field “construction” with the construction year of the building or renames it if there already exists a field named “constructi” or “year.

Parameters:

buildings (geopandas.GeoDataFrame) – GeoDataFrame containing buildings.

acept.buildings_information.calculate_year_class_from_construction(buildings: geopandas.GeoDataFrame)

Adds field “year_class” with the numerical year class of the construction year class. This is the classification used by the Zensus/BDB.

Parameters:

buildings (geopandas.GeoDataFrame) – GeoDataFrame containing buildings.

acept.buildings_information.calculate_building_type(buildings: geopandas.GeoDataFrame)

Adds field “building_type” with the building type, or renames it if there already exists a field named “type”, “btype” or “btype”.

Parameters:

buildings (geopandas.GeoDataFrame) – GeoDataFrame containing buildings.

acept.buildings_information.calculate_size_class(buildings: geopandas.GeoDataFrame)

Adds field “size_class” with the numerical size class corresponding to the building type. This classification is done independent of TABULAR classification (see EnvelopeArea_Residential.csv in UHP/input/Building Topology). Sets the building type to nan if no building type is given.

Parameters:

buildings (geopandas.GeoDataFrame) – GeoDataFrame containing buildings.

acept.buildings_information.initialize_floors(buildings: geopandas.GeoDataFrame)

Adds the empty field “floor” with the number of floors in the building.

Parameters:

buildings (geopandas.GeoDataFrame) – GeoDataFrame containing buildings.

acept.buildings_information.initialize_occupants(buildings: geopandas.GeoDataFrame)

Adds the empty field “occupants” with the number of occupants in the building.

Parameters:

buildings (geopandas.GeoDataFrame) – GeoDataFrame containing buildings.

acept.buildings_information.initialize_dwellings(buildings: geopandas.GeoDataFrame)

Adds the empty field “dwellings” with the number of dwellings in the building. If there is already a field named “houses_per_building” it is renamed to “dwellings”.

Parameters:

buildings (geopandas.GeoDataFrame) – GeoDataFrame containing buildings.

acept.buildings_information.initialize_ref_level(buildings: geopandas.GeoDataFrame, feature_name: str, default_value: int | None = None)

Adds the field “ref_level_{feature_name}” with the reference level for the given feature. If there is already a field corresponding to the refurbishment level of the feature it is renamed to “ref_level_{feature_name}”.

Parameters:

• buildings (geopandas.GeoDataFrame) – GeoDataFrame containing buildings.

• feature_name (str) – Name of the feature, must be ‘roof’, ‘wall’, ‘window’ or ‘floor’.

• default_value (int | None) – Value to use if there is no refurbishment level for the feature. Defaults to None.

Raises:

ValueError – If feature_name is not ‘roof’, ‘wall’, ‘window’ or ‘floor’.

acept.buildings_information.calculate_shape_around_buildings(buildings: geopandas.GeoDataFrame) → geopandas.GeoDataFrame

Calculate the shape around buildings in a GeoDataFrame.

Parameters:

buildings (geopandas.GeoDataFrame) – A GeoDataFrame containing the buildings.

Returns:

The shape around the selected buildings in a GeoDataFrame.

Return type:

geopandas.GeoDataFrame