OsmPublicTransportSettings

OsmPublicTransportSettings instance

The OsmPublicTransportSettings are accessible via the OsmIntermodalReaderSettings.pt_settings property. These settings are specific to the public transport infrastructure (not lines and services) of the network such as bus stops, train platforms, and stations.

During parsing these public transport OSM entities are converted into Planit Transfer zones (locations where modes can transfer, e.g. stations, stops), connectoids (where interaction between network agnostic zones and a physical network takes place, e.g. vehicle stop positions). Transfer zones, connectoids etc. are part of the PLANit Zoning.

Public transport Terminology

In the exposed methods we use certain terminology to indicate OSM entities (or groups). To avoid confusion the most common terms used are listed below:

OSM way: typically an OSM highway or OSM railway, but technically represents any line or polygon shape in an OSM file
OSM waiting area: represents any physical infrastructure where travelers might wait to board a public transport mode, e.g. bus pole, platform, station. A waiting area is generally not located on road infrastructure.
OSM stop(position): represents a location where pt modes stop to let travellers ingress/egress towards a waiting area. A stop position is generally located on road infrastructure
OSM stop area: represents a relation containing one or more OSM entities including for example stop positions, waiting area, but also pt lines

In PLANit terminology, an OSM way equates to a link(segment), an OSM waiting area equates to a transfer zone, while a stop(position) equates to a connectoid. Lastly, OSM stop areas equate to transfer zone groups although transfer zone groups simply group multiple transfer zones and do not include pt services or stop positions (explicitly).

Methods

A OsmPublicTransportSettings instance exposes the following methods.

Name	Default	Description
`.exclude_osm_node_by_id(+)`	N/A	Exclude OSM node by its OSM id, so it is not parsed anymore (as public transport infrastructure), e.g. bus stop poles, stand alone stations, etc.
`.exclude_osm_nodes_by_id(+)`	N/A	Exclude OSM nodes by their OSM id, so they are not parsed anymore (as public transport infrastructure), e.g. bus stop poles, stand alone stations, etc.
`.exclude_osm_way_by_id(+)`	N/A	Exclude OSM way by its OSM id, so it is not parsed anymore (as public transport infrastructure), e.g. platforms, platform edges, etc.
`.exclude_osm_ways_by_id(+)`	N/A	Exclude OSM ways by their OSM id, so they are not parsed anymore (as public transport infrastructure), e.g. platforms, platform edges, etc.
`.get_ferry_stop_to_ferry_route_search_radius_meters()`	100.0 (m)	Get the search radius set to search for OSM waterways around a dangling OSM ferry stop to connect to
`.get_overwritten_waiting_area_mode_access(+)`	N/A	Get the overwritten mode access set for the given waiting area.
`.has_overwrite_waiting_area_nominated_osm_way_for_stop_location(+)`	N/A	Verify if override exists for OSM waiting area to stop location.
`.is_connect_dangling_ferry_stop_to_nearby_ferry_route()`	True	Verify whether we attempt to connect dangling ferry stops to the nearest eligible OSM “water link”, i.e., OSM ferry route
`.is_excluded_osm_node(+)`	N/A	Verify if OSM node is excluded
`.is_excluded_osm_way(+)`	N/A	Verify if OSM way is excluded
`.is_remove_dangling_transfer_zone_groups()`	True	Verify if dangling transfer zone groups are to be removed
`.is_suppress_osm_relation_stop_area_logging(+)`	N/A	Verify if logging is suppressed for given stop area
`.overwrite_waiting_area_of_stop_location(+)`	N/A	Explicitly map stop locations to a particular OSM waiting area, overriding existing OSM mapping, or the automated procedure in the reader. Useful in case of tagging errors
`.overwrite_waiting_area_mode_access(+)`	N/A	Explicitly allow for an OSM waiting area to be services by roads with given mode access, even if the road type itself does not support this mode
`.overwrite_waiting_area_nominated_osm_way_for_stop_location(+)`	N/A	Explicitly map a OSM waiting area to find or create a stop location on the nominated OSM way. Useful in case of tagging errors
`.set_connect_dangling_ferry_stop_to_nearby_ferry_route(+)`	True	When any ferry stop is not connected to an OSM “water link”, i.e., OSM ferry route, connect it to the closest nearby water way within the designated search radius
`.set_ferry_stop_to_ferry_route_search_radius_meters(+)`	100.0 (m)	Set the search radius to search for OSM waterways around a dangling OSM ferry stop to connect to (if this feature is activated)
`.set_remove_dangling_transfer_zone_groups(+)`	True	Indicate if dangling zone groups, i.e., transfer zone groups without transfer zones are to be removed after the reader has completed
`.set_remove_dangling_zones(+)`	True	Indicate if dangling zones, i.e., created transfer zones without connectoids are to be removed after the reader has completed
`.set_station_to_waiting_area_search_radius_meters(+)`	35.0 (m)	Set the search radius to search for OSM waiting areas (platforms) around an OSM station if it is not part of an OSM stop area
`.set_stop_to_waiting_area_search_radius_meters(+)`	25.0 (m)	Set the search radius to search for OSM stop positions around an OSM waiting area if no explicit mapping is available
`.set_station_to_parallel_tracks_search_radius_meters(+)`	35.0 (m)	Set the search radius to search for parallel rail tracks around a stand-alone OSM station, i.e., without any nearby platforms nor part of stop area
`.suppress_osm_relation_stop_area_logging(+)`	N/A	Suppress logging for given stop areas if so desired (generally to clean up output after fixing/dealing with logged issues)

Properties

N/A

Example 1

from planit import *

# create an intermodal converter
planit_instance = Planit()
intermodal_converter = planit_instance.converter_factory.create(ConverterType.NETWORK)

# example Open Street Map (OSM) intermodal reader        
osm_reader = intermodal_converter.create_reader(IntermodalReaderType.OSM, "<country_name>")
osm_reader.settings.set_input_file("<path_to_input_file>")

# configure something on the OSM pt settings
osm_reader.settings.pt_settings.<some_method>

# example Planit intermodal writer
planit_writer = intermodal_converter.create_writer(IntermodalReaderType.PLANIT)
planit_writer.settings.set_output_directory("<path_to_output_dir>")
planit_writer.settings.set_country("<country_name>")

# perform conversion
intermodal_converter.convert(reader,writer)

Source code

Class OsmPublicTransportSettingsWrapper in converterwrappers.py

OsmPublicTransportSettings

Public transport Terminology

Methods

Properties

Example 1

See also

Source code

.exclude_osm_node_by_id(+)

.exclude_osm_nodes_by_id(+)

.exclude_osm_way_by_id(+)

.exclude_osm_ways_by_id(+)

.get_ferry_stop_to_ferry_route_search_radius_meters()

.get_overwritten_waiting_area_mode_access(+)

.has_waiting_area_nominated_osm_way_for_stop_location(+)

.is_connect_dangling_ferry_stop_to_nearby_ferry_route()

.is_excluded_osm_node(+)

.is_excluded_osm_way(+)

.is_remove_dangling_transfer_zone_groups()

.is_suppress_osm_relation_stop_area_logging(+)

.overwrite_waiting_area_mode_access(+)

.overwrite_waiting_area_nominated_osm_way_for_stop_location(+)

overwrite_waiting_area_of_stop_location.(+)

.set_connect_dangling_ferry_stop_to_nearby_ferry_route(+)

.set_ferry_stop_to_ferry_route_search_radius_meters(+)

.set_remove_dangling_transfer_zone_groups(+)

.set_remove_dangling_zones(+)

.set_station_to_parallel_tracks_search_radius_meters(+)

.set_station_to_waiting_area_search_radius_meters(+)

.set_stop_to_waiting_area_search_radius_meters(+)

.suppress_osm_relation_stop_area_logging(+)