visibility
Visibility and viewshed analysis.
visibility_graph
visibility_from_gpd
Run a visibility graph analysis. This will return three TIFF image files, respectively showing a density, farness, and harmonic closeness based measure.
Parameters
A GeoDataFrame containing building polygons.
A tuple specifying the bounds corresponding to the provided from_crs_code parameter.
An output path to which the generated TIFF images will be written. The pathname will be appended to correspond to the density, farness, and harmonic closeness measures.
The EPSG coordinate reference code corresponding to the input data.
An output EPSG coordinate reference code. None by default, in which case a UTM projection will be used.
The view distance within which to run the visibility analysis. 100m by default.
The spatial resolution in metres to use when generating the raster. Lower resolutions will result in faster analysis.
The height of the observer in metres. 1.5m by default.
visibility_graph_from_osm
visibility_from_osm
Retrieves OSM buildings for the specified WGS bounds and runs a visibility analysis. This will return three TIFF image files, respectively showing a density, farness, and harmonic closeness based measure.
Parameters
A tuple specifying the bounds corresponding to the provided from_crs_code parameter.
An output path to which the generated TIFF images will be written. The pathname will be appended to correspond to the density, farness, and harmonic closeness measures.
An output EPSG coordinate reference code. None by default, in which case a UTM projection will be used.
The view distance within which to run the visibility analysis. 100m by default.
The spatial resolution in metres to use when generating the raster. Lower resolutions will result in faster analysis.
The height of the observer in metres. 1.5m by default.
visibility_from_raster
Run a visibility graph analysis directly from a raster file. This will return three TIFF image files, respectively showing a density, farness, and harmonic closeness based measure.
Parameters
Path to the input raster file representing building heights or presence.
An output path to which the generated TIFF images will be written. The pathname will be appended to correspond to the density, farness, and harmonic closeness measures.
The view distance within which to run the visibility analysis. 100m by default.
The height of the observer in metres. 1.5m by default.
viewshed
viewshed_from_gpd
Run a viewshed analysis from a specified point. Writes an output image to the specified output path.
Parameters
A GeoDataFrame containing building polygons.
A tuple specifying the bounds corresponding to the provided from_crs_code parameter.
An easting or longitude for the origin of the viewshed in the from_crs_code coordinate reference system.
A northing or latitude for the origin of the viewshed in the from_crs_code coordinate reference system.
An output path to which the generated TIFF images will be written. The pathname will be appended to correspond to the density, farness, and harmonic closeness measures.
The EPSG coordinate reference code corresponding to the input data.
An output EPSG coordinate reference code. None by default, in which case a UTM projection will be used.
The view distance within which to run the visibility analysis. 100m by default.
The spatial resolution in metres to use when generating the raster. Lower resolutions will result in faster analysis.
The height of the observer in metres. 1.5m by default.
viewshed_from_osm
Run a viewshed analysis from a specified point using OSM data. Writes an output image to the specified output path.
Parameters
A tuple specifying the bounds corresponding to the provided from_crs_code parameter.
A longitude for the origin of the viewshed in WGS84 coordinates.
A latitude for the origin of the viewshed in WGS84 coordinates.
An output path to which the generated TIFF images will be written. The pathname will be appended to correspond to the density, farness, and harmonic closeness measures.
An output EPSG coordinate reference code. None by default, in which case a UTM projection will be used.
The view distance within which to run the visibility analysis. 100m by default.
The spatial resolution in metres to use when generating the raster. Lower resolutions will result in faster analysis.
The height of the observer in metres. 1.5m by default.