brails.types.region_boundary module

This module defines RegionBoundary class to store region boundary polygons.

RegionBoundary([input])

A class for obtaining the bounding polygon for a specified region.

class brails.types.region_boundary.RegionBoundary(input: dict | None = None)

Bases: object

A class for obtaining the bounding polygon for a specified region.

Attributes:

input (dict): The input data for the region.

Methods:
__init__(input): Initializes the RegionBoundary instance and validates

input.

get_boundary(): Returns the boundary polygon of the region provided.

get_boundary()

Return the current boundary.

Output: tuple

A tuple consisting of bpoly, query area and osmid