load_footprints(filename: str | Path, uuid_field='id', height_field='', area_filter=None, bounds=None, min_edge_distance=2.0) [<class 'dtcc_core.model.object.building.Building'>]

Load the buildings from a supported file and return a City object.

Parameters:
filename : str

The path to the shapefile.

uuid_field : str, optional

The name of the field containing the UUIDs (default “id”).

height_field : str, optional

The optional name of the field containing the building heights (default “”).

area_filter : float, optional

The minimum area of a building to include (default None).

bounds : Bounds, optional

The bounding box to filter the buildings (default None).

min_edge_distance : float, optional

The minimum distance between a building and the bounding box (default 2.0).

Returns:

A City object representing the city loaded from the shapefile.

Return type:

City