Table of Contents¶

georouting.routers.osmnx
OSMNXRouter

georouting.routers.osmnx¶

OSMNXRouter Objects¶

class OSMNXRouter(object)

OSMnx router for local routing using OpenStreetMap data.

This router downloads road network data from OpenStreetMap and performs routing calculations locally without requiring an API key.

Parameters¶

area : str The area to download road network for (e.g., "Piedmont, California, USA")
mode : str The routing mode. Can be "driving", "drive", "walking", "walk", "biking", "bike"
engine : str The graph engine to use. Currently supports "networkx". "igraph" support planned.
use_cache : bool Whether to cache downloaded road network data
log_console : bool Whether to log OSMnx messages to console

Returns¶

OSMNXRouter: A router object that can be used to get routes and distance matrices.

get_route¶

def get_route(origin, destination)

This method returns a Route object representing the route between the origin and destination points. The origin and destination parameters are tuples/list/arrays representing the starting and ending points for the route. The orgin and destination parameters should be in the form of iterable objects with two elements, such as (latitude, longitude) or [latitude, longitude].

Parameters¶

origin : iterable objects The origin point. Iterable objects with two elements, such as (latitude, longitude) or [latitude, longitude]
destination : iterable objects The destination point. Iterable objects with two elements, such as (latitude, longitude) or [latitude, longitude]

Returns¶

route : Route object The route between the origin and destination.

The returned Route object has the following functions:

get_distance() returns the distance of the route in meters.
get_duration() returns the duration of the route in seconds.
get_route() returns the raw route data returned as a dictionary.
get_route_geodataframe() returns the route as a GeoDataFrame.

get_distance_matrix¶

def get_distance_matrix(origins, destinations, append_od=False)

This method returns a Pandas dataframe representing a distance matrix between the origins and destinations points. It returns the duration and distance for all possible combinations between each origin and each destination. If you want just return the duration and distance for specific origin-destination pairs, use the get_distances_batch method.

The origins and destinations parameters are lists of origins and destinations.

If the append_od parameter is set to True, the method also returns a matrix of origin-destination pairs.

Note: Since this router performs local calculations, there are no API rate limits. However, very large matrices may be slow to compute depending on the road network size.

Parameters¶

origins : iterable objects An iterable object containing the origin points. It can be a list of tuples, a list of lists, a list of arrays, etc. It should be in the form of iterable objects with two elements, such as (latitude, longitude) or [latitude, longitude].
destinations : iterable objects An iterable object containing the destination points. It can be a list of tuples, a list of lists, a list of arrays, etc. It should be in the form of iterable objects with two elements, such as (latitude, longitude) or [latitude, longitude].
append_od : bool If True, the method also returns a matrix of origin-destination pairs.

Returns¶

distance_matrix : pandas.DataFrame A pandas DataFrame containing the distance matrix.

get_distances_batch¶

def get_distances_batch(origins, destinations, append_od=False)

This method returns a Pandas dataframe contains duration and disatnce for all the origins and destinations pairs. Use this function if you don't want to get duration and distance for all possible combinations between each origin and each destination.

The origins and destinations parameters are lists of origin-destination pairs. They should be the same length.

If the append_od parameter is set to True, the method also returns the input origin-destination pairs.

Parameters¶

origins : iterable objects An iterable object containing the origin points. It can be a list of tuples, a list of lists, a list of arrays, etc. It should be in the form of iterable objects with two elements, such as (latitude, longitude) or [latitude, longitude].
destinations : iterable objects An iterable object containing the destination points. It can be a list of tuples, a list of lists, a list of arrays, etc. It should be in the form of iterable objects with two elements, such as (latitude, longitude) or [latitude, longitude].
append_od : bool If True, the method also returns the input origin-destination pairs.

Returns¶

distance_matrix : pandas.DataFrame A pandas DataFrame containing the distance matrix.