brails.scrapers.footprint_scraper module

This module defines abstract FootprintScraper class

FootprintScraper(name)

Abstract base class representing a class that optains footprints for a region.

class brails.scrapers.footprint_scraper.FootprintScraper(name)

Bases: ABC

Abstract base class representing a class that optains footprints for a region.

Methods:

get_footprints(location): An abstract method to return the footprint given a location

abstract get_footprints(region: RegionBoundary) → AssetInventory

An abstract class that must be implemented by subclasses.

This method will be used by the caller to obtain the footprints for builings in an area.

Args:

region (Region):

The region of interest.

Returns:

BuildingInventory:

A building inventory for buildings in the region.