Skip to content

IsolineMatchingOptions

Source code in docs_src/capo_geo_routes/types/isoline_matching_options.py 
13
14
15
16
17
18
19
20
21
class IsolineMatchingOptions(TypedDict, closed=True):
    name_hint: NotRequired["capo_geo_routes.types.sensitive_string.SensitiveString"]
    """<p>The expected street name near the point. Helps disambiguate matching when multiple roads are within range.</p>"""
    on_road_threshold: "capo_geo_routes.types.distance_meters.DistanceMeters"
    """<p>The maximum distance in meters that a point can be from a road while still being considered "on" that road. Points further than this distance require explicit matching.</p> <p> <b>Unit</b>: <code>meters</code> </p>"""
    radius: "capo_geo_routes.types.distance_meters.DistanceMeters"
    """<p>The maximum distance in meters to search for roads to match to. Points with no roads within this radius will fail to match. The roads that are considered within this radius are determined by the specified <code>Strategy</code> </p> <p> <b>Unit</b>: <code>meters</code> </p>"""
    strategy: NotRequired["capo_geo_routes.types.matching_strategy.MatchingStrategy"]
    """<p>Determines how points are matched to the road network. <code>MatchAny</code> finds the nearest viable road segment, while <code>MatchMostSignificantRoad</code> prioritizes major roads.</p>"""

name_hint instance-attribute 

name_hint: NotRequired[SensitiveString]

The expected street name near the point. Helps disambiguate matching when multiple roads are within range.

on_road_threshold instance-attribute 

on_road_threshold: DistanceMeters

The maximum distance in meters that a point can be from a road while still being considered "on" that road. Points further than this distance require explicit matching.

Unit: meters

radius instance-attribute 

radius: DistanceMeters

The maximum distance in meters to search for roads to match to. Points with no roads within this radius will fail to match. The roads that are considered within this radius are determined by the specified Strategy

Unit: meters

strategy instance-attribute 

strategy: NotRequired[MatchingStrategy]

Determines how points are matched to the road network. MatchAny finds the nearest viable road segment, while MatchMostSignificantRoad prioritizes major roads.