brails.scrapers.ms_footprint_scraper.ms_footprint_handler module

This module defines MS_FootprintScraper class downloading Microsoft footprints.

MS_FootprintScraper(input_data)

A scraper class for downloading building footprints from Microsoft data.

class brails.scrapers.ms_footprint_scraper.ms_footprint_handler.MS_FootprintScraper(input_data: dict)

Bases: FootprintScraper

A scraper class for downloading building footprints from Microsoft data.

This class is designed to retrieve building footprint data for a specified region using quadkeys, download the data from Microsoft’s dataset, and provide an inventory of building footprints and their attributes, such as building height. It supports multiple units for building height (i.e., feet or meters).

Attributes:

length_unit (str): The unit of measurement for building height, either: ‘ft’ (feet) or ‘m’ (meters). The default is ‘ft’ (feet) if not specified.

Methods:

get_footprints(region: RegionBoundary) -> AssetInventory: Retrieves: building footprints and their attributes for the specified region.

get_footprints(region: RegionBoundary) → AssetInventory

Retrieve building footprints and associated attributes for a region.

This method takes a RegionBoundary object, extracts the region’s boundary, determines the relevant quadkeys for that region, downloads the building footprint data, and returns an AssetInventory containing the building footprints and other attributes (e.g., building height).

Args:

region (RegionBoundary): The region of interest containing the: geographical boundary.

Returns:

AssetInventory: An inventory of buildings within the specified: region, including their footprints and attributes (such as building height).