osm2po - openstreetmap converter and routing engine for java

model

created with XMind

about

For a first impression start the SlideShow

osm2po-core (FreeWare)

osm2po is both, a converter and a routing engine.
osm2po's converter parses OpenStreetMap's XML-Data and makes it routable.
osm2po is able to convert large sets like europe.osm
osm2po generates sql files for PostGIS, compatible with pgRouting and Quantum GIS.
osm2po creates compact topology/graph files for the integrated routing engine.
osm2po contains a simple HTTP routing server which returns CSV, GeoJson, SOAP or starts the WebTest-GUI.
osm2po runs under Windows, Unix and Mac. Just make sure you have Java 6+ installed.
osm2po does not depend on foreign Java libraries.
osm2po's core is just one file. No installation is needed.

Licence
You are free to make copies, give exact copies of the original to anyone,
distribute it in its unmodified form via electronic means.
You may not reverse engineer, de-compile or disassemble it, rent, lease, lend or sell it.
This software is provided 'AS IS', without warranty of any kind,
so use it at your own risk.

osm2po-plugins (OpenSource)

Creates another PostGIS-Table of Vertices
Enables osm2po to read from osm.bz2, pbf, o5m and o5m.gz
Provides some Java programming exsamples

downloads

osm2po 4.7.7 2013-04-04		Another step forward. This time I've been concentrating on the osm2po routing again. Like always (sorry for that) some things had to be changed. But as long as you don't mix old with new data everything will work as usual. Here are the upcoming main features: Extensible Graph-File. Meaning, you can add custom data to the container in case you need a custom routing. MlgBuilder (MLG = MultiLevelGrid) A new postprocessor, which utilizes the new extension mechanism to enrich the graph with few Highway-Levels. It bases on a geometric container concept which is not the fastest speed up technique but shows high preprocessing performance. I do not add shortcuts, so I can keep up my main goal to be fully compatible with the corresponding PostGIS/pgRouting tables and of course with the underlying OSM-Data. Another benefit is the insignificant memory overhead around 2% per use case. A new MlgRouter (MultiLevelGridRouter) which is an at least five times faster DefaultRouter. On dense networks with more low level roads like service streets, pedestrian areas, etc. the performance even increases up to ten or higher. You might wonder now: Actually, it is not a BidiRouter, it's a simple forward router!
osm2po 4.6.9 2013-01-05		Tech-Version with lots of improvements under the hood. On the one hand this release is driven by many requests I received over the past months, on the other by some ideas I had myself. Due to the bulk of changes, most of the files osm2po creates are not compatible with older versions anymore. So if you're going to upgrade to this version, you'll have to convert your existing extracts again. Here are some key features: Easier and shorter syntax for the street type definitions inside the configuration. Improved memory usage, especially in the segmenting phase. I added a merger module which lets you overlay different extracts, areas or even configurations between the joining and the segmenting phase. The OverlayRouter has been replaced by DefaultRouter2 and an additional EdgeRouter2. The RoutingResultSegment contains an already calculated and correct km and h in case the ratio does not equal 1. The SOAP-wsdl has been modified as well. Now it acts more consistently with reference to the REST interface. Osm2po's service now provides an i18n error messages bundle. Meaning, you'll receive reliable error numbers and messages from the SOAP- as well as from the REST interface. I added some more map layers to the WebTestUI. So if one of them fails to load (mapnik is a notorious candidate for it) you can switch to another. I even added a hillshading layer, which gives you an impression of 2.5D.
osm2po 4.5.25 2012-10-11		Feature Version with lots of improvements under the hood Support for Openstreetmap's new o5m file format. Experimental but working Overlay-Graph-Technique added. osm2po is now able to start and finish at random points, not only at links. Due to the latter, the wsdl (SOAP) has changed. The osm2po-converter for PostGIS/pgRouting has not been modified. However, found some minor bugs and fixed them.
osm2po 4.5.2 2012-08-04		Feature-Version with lots of improvements under the hood The PostGIS-SQL-Export (pgRoutingWriter) creates LINESTRINGs instead of MULTILINESTRINGs by default. The TSP (which is still beta) is able to calculate routes with different source and target (no roundtrip)
osm2po 4.4.55 2012-03-14		Tech-Version with lots of improvements under the hood UI-ShortKeys for analyzing data. Ctrl-Shift-Click: shows closest vertex and outgoing edges, Ctrl-Alt-Click: shows closest Edge or, if closer, the closest vertex with its edges. Direct UI-DownLoad-Link to OSM-Api which retrieves the raw xml data of the current view. BugFix: turn restrictions not recognized if oneways are involved. Puhhhh - what a bug!!!
osm2po 4.4.4a 2012-03-14		Patch Version for 4.4.4 Surprise, surprise ;-( Broken dependency on OpenStreetMap.js because TilesAtHome (Osmarender) doesn't exist anymore.
osm2po 4.4.4 2012-03-09		Feature Version with lots of improvements under the hood New: Multithreaded Routing! StressTest (System 3GHz/2GB -Xmx300m reserverd) : I emulated 100 Users requesting random routes on germany.osm in parallel. osm2po performed each request peacefully. Bugfix: osm2po doesn't accept input sources like http://api.openstreetmap.org/api?map=... directly. New: Routing as SOAP-Service. The link to the wsdl can be found in the Web-GUI. Modified: Enriched set of attributes for the HTTP/GET-GeoJson- Response. English OnScreen-Help. Start osm2po with either -h, help or --help.
osm2po 4.3.8 2012-02-04		Feature Version with lots of improvements under the hood The osm2po-routing has been modified and hence is not compatible with version 4.2.x anymore. Now, instead of writing lots of `g.2po`-Files, the GraphBuilder* creates one single File with a `.gph` extension. This file contains the entire graph including geometries and street-names. Because of the new Graph-File, the routing itself uses different Java-Classes. So if you are using osm2po as Standalone-Router (as Java-Lib) look at the new Sample on the Tipps-Tab. The osm2po-converter for PostGIS/pgRouting has not been changed. However, found some minor bugs and fixed them.
osm2po 4.2.30 2011-11-21		Feature Version with lots of improvements under the hood The osm2po-routing now contains a Driving-Distance, an AStar and an experimental Travelling-Salesman. Therefore I had to change some interfaces in the routing library. Hence, if you are running osm2po-routing as standalone, contact me for further infos. I also had to change the format of one generated routing file. So don't use older `g.2po` files. To make it compatible, just convert it again with the `cmd=g` parameter. The osm2po-converter* for PostGIS/pgRouting has not been changed. However, found some minor bugs and fixed them. I've changed some default settings in the osm2po.config file. Most important: I've renumbered the Class-IDs for Streets. So be careful, if things depend on these defaults. An experimental but powerful feature is osm2po's new GeoJson support. Just start the osm2po-Service and directly visualize a route in QuantumGis.
osm2po 4.1.9 2011-08-15		Feature Version with lots of improvements under the hood First osm2po-Version which routes over the entire OSM-Planet-File.
osm2po 1.1.3 2010-07-26		First official Version

data

	OpenStreetMap entire planet as bz2 or pbf (search for planet-latest)
	Geofabrik extracts as bz2 or pbf
	Other sources listed in the OSM-Wiki

help

Help current on-screen help

        
CALL SYNTAX : java [-Xmx] -jar osm2po.jar [param=value]* [inputfile]

-Xmx        : Important JAVA-Parameter for Memory-Reservation
              e.g. -Xmx512m (512 MB), -Xmx2g (2GB).

param=value : osm2po parameters. Must not contain any Spaces.
              param=value is one single string!

inputfile   : Path to an input source.
              Depends on the cmd-parameter if mandatory or not.

PARAMETERS    (are case sensitive)

cmd         : Most important parameter, which tells osm2po what to do.
              The value contains a sequence of lower case letters.
              Default is cmd=tjspgr, which executes the entire process
              chain. But you can also run each process separately.
              e.g. cmd=tjs cmd=g

              TABLE OF COMMANDS

              cmd | Context    | Depends on / Description
              ---------------------------------------------------------
              t   | Conversion |   | Parses and filters an OSM-Input file.
              j   | Conversion | t | Joins Nodes, Ways and Relations
              s   | Conversion | j | Transforms and creates the topology
              p   | Result     | s | Starts each configured postprocess.
                  |            |   | By default it outputs postGIS-SQLs.
              g   | Result     | s | Creates the *.gph Graph-File for
                  |            |   | the osm2po-routing.
              r   | Service    | g | Starts the osm2po-routing which
                  |            |   | is a simple http/get web-server.
              d   | Debug      |   | Prints out a *.2po-File.
              c   | Shortcut   |   | For lazy people. Sets cmd=tjsp

              cmd=t needs an input source to process. This may be a
              local path or a http address. If not given it
              reads from stdin. cmd=jspg work directory based.
              (see workDir)

              cmd=tjs - What really happens:

                    [2] 5                             [3] 4
                       /                                 /
                      6                                 +
                      |            ___|\                |
              [1] 1---2---3        tjs  \       [1] 1---2---+
                      |    \       ___  /               |    \
                      |     \         |/                |     \
                      7      4                      [4] 5      3 [2]

              1,2,3,4,5,6,7 are OSM-Nodes       [1] 1,2  (OSM-Way [1])
              [1] OSM-Way (Nodes 1,2,3,4)       [2] 2,3  (OSM-Way [1])
              [2] OSM-Way (Nodes 5,6,2,7)       [3] 4,2  (OSM-Way [2])
                                                [4] 2,5  (OSM-Way [2])

              OSM-Data IS NOT ROUTABLE!         OSM2PO-Data IS ROUTABLE!

tileSize    : Most important parameter for the conversion.
              It controls the balance between available memory and
              data size. The rule is simple:
              The more memory and the larger a tile the better.
              tileSize takes up to three sub-values, separated by kommas.
              The pattern is: [<Y>x<X>|x][,<buffer>][,c]
              It defaults to tileSize=1x1,0.1 (in degrees. c is not set)
              where Y,X are Integers and buffer a Float. 1x1,0.1 is a very
              pessimistic value and should be increased for larger countries.
              It is possible to set 7x9 e.g. but divisors of 90 and 180
              are recommended.
              The buffer is needed for ways that cross tiles.
              If a way is too long and the buffer too small, it
              cannot be resolved and will be skipped.
              Setting tileSize=x disables tiling at all, which is optimal
              but directly dependent on the available memory given
              by the -Xmx Java-Parameter (see above).
              The small c is another switch that influences the behavior.
              If given, osm2po writes nodes to a temp file first. While
              reading the ways it registers all referenced Node-Ids and
              finally starts tiling as postprocess where not used
              Nodes will be dropped. This may help saving memory
              if you have small tiles with large buffers but is much slower.
              Hint: The conversion (tjs) writes *.2po temp files.
                    t*.2po files result from cmd=t, j*.2po from j, etc.
                    if osm2po creates too many of them (>100) you'd better
                    increased tileSize.

prefix      : Another important parameter. It should be set in order to
              uniquely prefix generated names for files or tables.
              If not given, it defaults to prefix=osm. But keep it short
              and reasonable! e.g. 'de' for Germany or 'hh' for Hamburg.

workDir     : Directory where osm2po creates temporary *.2po files
              and the results, e.g. *.gph, *.sql.
              Default is workDir=<prefix> If both are not set,
              osm2po will create an 'osm' folder in the current
              directory, because 'osm' is the default for prefix.

more...     : Other documented parameters can be found in the
              osm2po.config file. Each entry can also be used as
              commandline parameter whereby it overrides the config.
              But do not forget to remove the spaces if copied from that file.

Conversion sample calls

        
Here are some successful calls in order to convert OSM-Data to
postGIS/pgRouting. These samples also start the osm2po-Service.
If you are not interested in the latter, add the parameter
[cmd=c] to each call. But this will not generate the native
routing file (*2po.gph).

System / RAM / Data / Source / Ways / Unresolved
Command
________________________________________________________________________________

x32 / 1G  / Hamburg 08/2011 / Geofabrik / 29K / 0
[java -jar osm2po-xxx.jar prefix=hh hamburg.osm.pbf]

x32 / 1G  / Germany 05/2011 / Geofabrik / 2.6M / 0
[java -Xmx640m -jar osm2po-xxx.jar prefix=de tileSize=10x10,0.5 germany.osm.pbf]

x32 / 2G  / Germany 05/2011 / Geofabrik / 2.6M / 0
[java -Xmx1408m -jar osm2po-xxx.jar prefix=de tileSize=x,c germany.osm.pbf]

x32 / 2G  / Europe 05/2011 / Geofabrik / 11.6M / 23
[java -Xmx1408m -jar osm2po-xxx.jar prefix=eu tileSize=10x10,1,c europe.osm.pbf]

x64 / 4G  / Europe 08/2011 / Geofabrik / 12.6M / 3
[java -Xmx3g -jar osm2po-xxx.jar prefix=eu tileSize=15x15,1,c europe.osm.pbf]

x64 / 8G  / Europe 08/2011 / Geofabrik / 12.6M / 0
[java -Xmx6g -jar osm2po-xxx.jar prefix=eu tileSize=x,c europe.osm.pbf]

x64 / 8G  / Planet 08/2011 / OSM / 35.5M / 7
[java -Xmx6g -jar osm2po-xxx.jar prefix=pl tileSize=45x45,1,c planet.osm.pbf]

________________________________________________________________________________
Notes:

1) (Number of) ways include:
highway=primary, highway=primary_link, highway=secondary, highway=secondary_link,
highway=tertiary, highway=motorway, highway=motorway_link, highway=trunk,
highway=trunk_link, highway=residential, highway=road, highway=unclassified,
highway=service, route=ferry, railway=rail (if shuttle_train)

QuantumGIS requesting GeoJson Layer

        
It is possible to calculate a route in osm2po,
output the result as GeoJson and to add it as
a layer in QuantumGIS.

* Convert the graph file with [cmd=g]
  and start osm2po with [cmd=r] (Service)

* If you need the street-types (-class)
  enable them by setting
  [graph.support.edgeflags=true] either in the
  osm2po.config file or as additional parameter
  on the commandline.

* Instead of opening the WebGUI in your Browser
  with e.g. [http://localhost:8888/Osm2poService]
  add these Parameters to the address above

  [?cmd=fr&source=100&target=1000&format=geojson]

* The Browser should show you the routing result
  as plain text in geojson format (UTF8).

* If this works, copy the complete address,
  open your QuantumGIS and add the layer under
  [Menu-Layers-Add_VectorLayer]
  A Dialog opens. Set the [protocol] to
  [GeoJSON] and the [Encoding] to [UTF8]
  Finally paste the address into the [URI] Field and
  click [Open]

* The same works with driving circle distance.
  Here osm2po creates a cloud of points (in geojson-format)
  which are reachable in either time or distance from a given
  starting point (source). e.g.:

  1) Show each point which can be reached within a distance of
     5 km from starting point (53.5,10.0):

     [?cmd=fx&source=53.5,10.0&findShortestPath=true&maxCost=5.0&format=geojson]

  2) Show each point which can be reached within a distance of
     12 Minutes (0.2 hours) from starting point (53.5,10.0).

     [?cmd=fx&source=53.5,10.0&findShortestPath=false&maxCost=0.2&format=geojson]

Java osm2po as library

        
File graphFile = new File(args[0]);
Graph graph = new Graph(graphFile);
SinglePathRouter router = new DefaultRouter();

// Somewhere in Hamburg
int sourceId = graph.findClosestVertexId(53.5f, 10.0f);
int targetId = graph.findClosestVertexId(53.4f, 10.1f);

// Possible additional params for DefaultRouter
Properties params = new Properties();
params.setProperty("findShortestPath", "false");
params.setProperty("ignoreRestrictions", "false");
params.setProperty("ignoreOneWays", "false");
params.setProperty("heuristicFactor", "1.0"); // 0.0 Dijkstra, 1.0 good A*

int[] path = router.findPath(
    graph, sourceId, targetId, Float.MAX_VALUE, params);

if (path != null) { // Found!
    for (int i = 0; i < path.length; i++) {
        RoutingResultSegment rrs = graph.lookupSegment(path[i]);
        int segId = rrs.getId();
        int from = rrs.getSourceId();
        int to = rrs.getTargetId();
        String segName = rrs.getName().toString();
        System.out.println(from + "-" + to + "  " + segId + "/" + path[i] + " " + segName);
    }
}

graph.close();

More on the Web

Q&A on GIS-StackExchange	How to create a distance matrix using osm2po's Java-Lib? How to take barriers into account in pgRouting or osm2po? How to calculate a ConvexHull in osm2po? How to configure different costs, e.g. for bike routing? Does osm2po support turn restrictions for pgRouting? How can I avoid memory problems when importing sql for pgRouting.
osm2po Tutorial Part I	A very good indroduction to osm2po by Anita Graser (Underdark).
osm2po Tutorial Part II	The sequel to osm2po QuickStart by Anita Graser (Underdark).

impressum

Responsible for the content of this website:

Carsten Moeller
Dingstaette 12
D-25421 Pinneberg
Germany

email

Disclaimer:
Despite careful control of the contents,
I do not assume any liability for the content of any sites linked to from this Web site.
I do not control sites linked to and assume no responsibility for their content.
Solely the operators of sites linked to are responsible for the content of said sites.

Routing On OpenStreetMap