brails.scrapers.footprint_scraper module

This module defines abstract FootprintScraper class.

FootprintScraper(name)

Abstract base class for getting building footprints within a region.

class brails.scrapers.footprint_scraper.FootprintScraper(name)

Bases: ABC

Abstract base class for getting building footprints within a region.

This class defines the interface for any footprint scraper implementation.

name

Name or identifier for the scraper.

Type:: str

footprints

A list to store retrieved footprint geometries.

Type:: List

centroids

A list to store centroid coordinates of the footprints.

Type:: List

get_footprints(region): Abstract method to return building footprints for a given region.

abstract get_footprints(region)

Retrieve building footprints and attributes within a specified region.

This method must be implemented by subclasses to provide access to building-level footprint and attribute data for a given geographic boundary. It is typically used by downstream components to extract spatial information for analysis or visualization.

Parameters:: region (RegionBoundary) – The geographic region of interest.
Returns:: An inventory containing the footprints of buildings within the specified region.
Return type:: AssetInventory