Skip to content

Commit

Permalink
update GLAMOUR examples
Browse files Browse the repository at this point in the history
  • Loading branch information
lyy committed Dec 30, 2023
1 parent 0f1b6e8 commit 4835a19
Show file tree
Hide file tree
Showing 3 changed files with 457 additions and 0 deletions.
15 changes: 15 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Example usages of SHAFTS and its global mapping results

Here we offer some example usages of `SHAFTS` and its associated global mapping results, namely the `GLAMOUR` dataset, which offers the average building footprint and height at the resolution of 100 m in global urban centers.

## Overview of examples

- `case_run.py` uses the deep-learning-based models in SHAFTS to predict the average building footprint and height in multiple cities with multiple resolutions.

- `data_download.py` downloads the Sentinel-2 images with a given geospatial extent and year.

- `glamour.py` offers functions such as `get_glamour_by_extent`, `vis_glamour_by_extent_2d`, `vis_glamour_by_extent_3d` and `ana_glamour_joint_distribution` to retrieve, visualize and analysis the average building footprint and height from the the `GLAMOUR` dataset.
The `GLAMOUR` dataset can be requested from this [link](https://zenodo.org/records/10396451) and will be released publicly in January, 2024.
Please also note that additional Python packages including [contextily](https://contextily.readthedocs.io/) and [pydeck](https://pydeck.gl/) should be installed to run this script.

- `minmum_case_run.py` uses the deep-learning-based models in SHAFTS to predict the average building footprint and height in a single city with a single resolution.
Binary file added example/data/tz_mask.gpkg
Binary file not shown.
Loading

0 comments on commit 4835a19

Please sign in to comment.