Skip to content
Snippets Groups Projects

Resolve "Introduce a new filter for when rules should be run based on the source ID of a building."

Compare and Show latest version
3 files
+ 40
52
Compare changes
  • Side-by-side
  • Inline
Files
3
+ 18
30
@@ -18,7 +18,6 @@
import abc
from typing import Union
import shapely
@@ -30,16 +29,21 @@ class AbstractRule(abc.ABC):
Args:
rule_source_ids (list):
A list of all valid source IDs for the rule.
A list of all valid source IDs for the rule. This is provided by the rule's XML file
if relevant.
geographic_filter_boundary (str):
Boundary polygon in WKT format defining the geographic boundary of the rule.
"""
def __init__(self, rule_source_ids: list = None, geographic_filter_boundary: str = None):
def __init__(
self,
rule_source_ids: list | None = None,
geographic_filter_boundary: str | None = None,
):
self.geographic_filter_boundary_geometry = None
if geographic_filter_boundary is not None:
self.geographic_filter_boundary_geometry = self.read_geometry_from_wkt(
self.geographic_filter_boundary_geometry = shapely.from_wkt(
geographic_filter_boundary
)
@@ -51,7 +55,7 @@ class AbstractRule(abc.ABC):
The `__call__` method implements the core process of the rule.
"""
def parse_data(self, data: Union[str, bytes], source_file: str):
def parse_data(self, data: str | bytes, source_file: str):
"""
The `parse_data` method can be used to parse files that are attached to the
rule. As file types can widely vary, this method needs to be implemented for each
@@ -72,34 +76,18 @@ class AbstractRule(abc.ABC):
+ "please implement this class first."
)
@staticmethod
def read_geometry_from_wkt(geographic_filter_boundary):
"""
Converts a WKT boundary into a Shapely polygon.
Args:
geographic_filter_boundary (str):
Boundary polygon in WKT format defining the geographic boundary of the rule.
Returns:
shapely.geometry.polygon.Polygon:
A Shapely polygon based on the WKT string geometry.
"""
return shapely.from_wkt(geographic_filter_boundary)
def filter(
self,
longitude: float = None,
latitude: float = None,
source_id: int = None,
longitude: float | None = None,
latitude: float | None = None,
source_id: int | None = None,
*args,
**kwargs
):
"""
Applies a spatial filter to ensure that only buildings within the provided geographic
polygon are processed and a source filter to ensure source-specific rules only run
for inputs with a matching source ID.
for buildings with a matching source ID.
Args:
longitude (float):
@@ -107,14 +95,15 @@ class AbstractRule(abc.ABC):
latitude (float):
Latitude of the building being processed.
source_id (int):
Integer representing the data-source ID, and determines the rule's relevance.
Integer representing the building-source ID.
Returns:
bool:
`True` if all tests pass and `False` if at least one doesn't pass.
True if all tests pass and False if at least one does not pass.
"""
# Geographic filter, passes if the inputs coordinates lie within the boundary geometry.
# Geographic filter, passes if the building's coordinates lie within the boundary
# geometry.
if (
self.geographic_filter_boundary_geometry is not None
and self.geographic_filter_boundary_geometry.disjoint(
@@ -123,8 +112,7 @@ class AbstractRule(abc.ABC):
):
return False
# Source ID filter, passes if the rules and the inputs source ID match.
# Source ID filter, passes if the rule's source ID and the building-source ID match.
if self.rule_source_ids is not None and source_id not in self.rule_source_ids:
return False
return True
Loading