search_3dglobdf {gloBFPr} | R Documentation |
search_3dglobdf
Description
Search and retrieve 3D-GloBFP tiles that intersect a given bounding box or area of interest, with options to return vector or raster outputs including building polygons, binary presence rasters, and height-coded rasters.
Usage
search_3dglobdf(
bbox,
metadata,
crop = FALSE,
out_type = "poly",
mask = FALSE,
cell_size = 1
)
Arguments
bbox |
|
metadata |
sf. Typically output from |
crop |
logical. If |
out_type |
character. Default is
|
mask |
logical (optional). Default is |
cell_size |
numeric (optional). Default is 1. Only used when |
Value
Varies based on out_type
:
If
"poly"
: ansf
object of building footprints.If
"binary_rast"
: a binarySpatRaster
(terra
) indicating building presence.If
"graduated_rast"
: a quantitativeSpatRaster
of building heights.If
"rast"
: a named list with twoSpatRaster
objects:binary
andgraduated
.If
"all"
: a named list withpoly
(sf),binary
, andgraduated
rasters.
Note
The downloading process may take some time, depending on the number and size of building footprint tiles.
This implementation relies on the current structure of the dataset as hosted on Figshare. It may break if the dataset owner changes the file organization or metadata format.
References
Che Yangzi, Li Xuecao, Liu Xiaoping, Wang Yuhao, Liao Weilin, Zheng Xianwei, Zhang Xucai, Xu Xiaocong, Shi Qian, Zhu Jiajun, Zhang Honghui, Yuan Hua, & Dai Yongjiu (2024). 3D-GloBFP: the first global three-dimensional building footprint dataset. Earth Syst. Sci. Data, 16, 5357-5374
Examples
metadata <- gloBFPr::get_metadata(test=TRUE)
buildings <- gloBFPr::search_3dglobdf(bbox=c(-84.485519,45.636118,-84.462774,45.650639),
metadata=metadata)