Map matching (wherobots.matcher)

from wherobots import matcher

load_osm

load_osm(osm_path: str, tags_filter: str = '') -> DataFrame

Function loads an OSM xml file and retrieves all the edges and locations of the corresponding nodes.

Parameters

str

required

A string that represents path to the OSM xml file

str

default:"''"

A string denoting the tags to be used for filtering the OSM data

Returns

DataFrame

A DataFrame object containing all the edges information required for map matching

match

match(
    edges_df: DataFrame,
    paths_df: DataFrame,
    edges_geometry: str,
    paths_geometry: str,
    id: str = None,
) -> DataFrame

Function performs map matching for a GPS path.

Parameters

DataFrame

required

DataFrame object that contains all edges in the target dataset

DataFrame

required

DataFrame object that contains all GPS trips for which map matching need to be performed

str

required

Name of the geometry column in the edgesDf DataFrame

str

required

Name of the geometry column in the pathsDf DataFrame

str

default:"None"

Optional - Name of the column in the pathsDf DataFrame that contains the unique identifier for each GPS trip. if not provided, the first non-geometry column is used.

Returns

DataFrame

A DataFrame object containing the results of map matching

​load_osm

​Parameters

​Returns

​match

​Parameters

​Returns

load_osm

Parameters

Returns

match

Parameters

Returns