The GeoScale class

A nested spatial partition: a flat table of weighted leaf regions ("atoms") plus the ordered geoframes that group them.

GeoScale

Bases: NestedScale

A nested spatial partition; key column region.

__getitem__(idx: tuple) -> GeoScale

gs[geoframe, region] is filter_geoscale().

geoscale_example() -> GeoScale

A synthetic 7-atom scale: code "N1" reused at two geoframes, zone ZB cross-cutting, and atom ROW unassigned at every coarser geoframe.

geoscale_geoframes(x: GeoScale, finest: bool = False)

geoscale_regions(
    x: GeoScale, geoframe: str | None = None
) -> list[str]

The ordered codes at a geoframe (default: the atoms).

geoscale_rank(x: GeoScale, geoframe: str | Sequence[str])

Position of a geoframe (1 = coarsest); None when not a geoframe.

geoscale_weights(x: GeoScale) -> list[str]

geoscale_summary(x: GeoScale) -> GeoScaleSummary