cityImage.obstructions_2d#

cityImage.obstructions_2d(potential_sight_lines, obstructions_gdf, obstructions_sindex, num_workers=20)[source]#

Split candidate sight lines by 2D planimetric obstruction status.

Parameters:

  • potential_sight_lines (geopandas.GeoDataFrame) – Candidate sight lines with 2D line geometry.

  • obstructions_gdf (geopandas.GeoDataFrame) – Obstruction geometries with a buildingID column.

  • obstructions_sindex (geopandas.sindex.SpatialIndex) – Spatial index built from obstructions_gdf.

  • num_workers (int, default 20) – Number of worker threads used by Dask.

Returns:

Visible lines and lines that require 3D obstruction testing.

Return type:

tuple[geopandas.GeoDataFrame, geopandas.GeoDataFrame]