Check out the latest version of Routino: svn co http://routino.org/svn/trunk routino
Annotation of /trunk/doc/html/usage.html
Parent Directory
|
Revision Log
Revision 2141 -
(hide annotations)
(download)
(as text)
Tue Jun 6 18:05:10 2023 UTC (22 months, 1 week ago) by amb
File MIME type: text/html
File size: 28109 byte(s)
Tue Jun 6 18:05:10 2023 UTC (22 months, 1 week ago) by amb
File MIME type: text/html
File size: 28109 byte(s)
Change the default amount of sorting RAM from 64 or 256 MB to 256 or 1024 MB.
1 | amb | 1469 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
2 | <html> | ||
3 | amb | 577 | |
4 | amb | 1469 | <head> |
5 | amb | 1257 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
6 | amb | 1646 | <meta name="viewport" content="width=device-width, initial-scale=1"> |
7 | amb | 1257 | |
8 | <title>Routino : Usage</title> | ||
9 | |||
10 | amb | 577 | <!-- |
11 | amb | 584 | Routino documentation - usage |
12 | amb | 577 | |
13 | Part of the Routino routing software. | ||
14 | |||
15 | amb | 2141 | This file Copyright 2008-2015, 2020, 2023 Andrew M. Bishop |
16 | amb | 577 | |
17 | This program is free software: you can redistribute it and/or modify | ||
18 | it under the terms of the GNU Affero General Public License as published by | ||
19 | the Free Software Foundation, either version 3 of the License, or | ||
20 | (at your option) any later version. | ||
21 | |||
22 | This program is distributed in the hope that it will be useful, | ||
23 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
24 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
25 | GNU Affero General Public License for more details. | ||
26 | |||
27 | You should have received a copy of the GNU Affero General Public License | ||
28 | along with this program. If not, see http://www.gnu.org/licenses/. | ||
29 | --> | ||
30 | |||
31 | amb | 1257 | <link href="style.css" type="text/css" rel="stylesheet"> |
32 | amb | 1469 | </head> |
33 | amb | 577 | |
34 | amb | 1469 | <body> |
35 | amb | 577 | |
36 | <!-- Header Start --> | ||
37 | |||
38 | amb | 1469 | <div class="header"> |
39 | amb | 577 | |
40 | <h1>Routino : Usage</h1> | ||
41 | |||
42 | </div> | ||
43 | |||
44 | <!-- Header End --> | ||
45 | |||
46 | <!-- Content Start --> | ||
47 | |||
48 | <div class="content"> | ||
49 | |||
50 | amb | 1474 | <h2 id="H_1_1">Program Usage</h2> |
51 | amb | 577 | |
52 | amb | 1149 | There are five programs that make up this software. The first one takes the |
53 | amb | 577 | planet.osm datafile from OpenStreetMap (or other source of data using the same |
54 | formats) and converts it into a local database. The second program uses the | ||
55 | database to determine an optimum route between two points. The third program | ||
56 | allows visualisation of the data and statistics to be extracted. The fourth | ||
57 | amb | 1149 | program allows dumping the raw parsed data for test purposes and the fifth is a |
58 | test program for the tag transformations. | ||
59 | amb | 577 | |
60 | amb | 1474 | <h3 id="H_1_1_1">planetsplitter</h3> |
61 | amb | 577 | |
62 | This program reads in the OSM format XML file and splits it up to create the | ||
63 | database that is used for routing. | ||
64 | |||
65 | <pre class="boxed"> | ||
66 | amb | 1797 | Usage: planetsplitter [--version] |
67 | [--help] | ||
68 | amb | 577 | [--dir=<dirname>] [--prefix=<name>] |
69 | amb | 991 | [--sort-ram-size=<size>] [--sort-threads=<number>] |
70 | amb | 577 | [--tmpdir=<dirname>] |
71 | amb | 953 | [--tagging=<filename>] |
72 | amb | 1598 | [--loggable] [--logtime] [--logmemory] |
73 | amb | 982 | [--errorlog[=<name>]] |
74 | amb | 577 | [--parse-only | --process-only] |
75 | amb | 1167 | [--append] [--keep] [--changes] |
76 | amb | 577 | [--max-iterations=<number>] |
77 | amb | 975 | [--prune-none] |
78 | [--prune-isolated=<len>] | ||
79 | [--prune-short=<len>] | ||
80 | [--prune-straight=<len>] | ||
81 | amb | 1197 | [<filename.osm> ... | <filename.osc> ... |
82 | amb | 1227 | | <filename.pbf> ... |
83 | | <filename.o5m> ... | <filename.o5c> ... | ||
84 | | <filename.(osm|osc|o5m|o5c).bz2> ... | ||
85 | amb | 1514 | | <filename.(osm|osc|o5m|o5c).gz> ... |
86 | | <filename.(osm|osc|o5m|o5c).xz> ...] | ||
87 | amb | 577 | </pre> |
88 | |||
89 | <dl> | ||
90 | amb | 1797 | <dt>--version |
91 | <dd>Print the version of Routino. | ||
92 | amb | 577 | <dt>--help |
93 | <dd>Prints out the help information. | ||
94 | <dt>--dir=<dirname> | ||
95 | <dd>Sets the directory name in which to save the results. | ||
96 | Defaults to the current directory. | ||
97 | <dt>--prefix=<name> | ||
98 | <dd>Sets the filename prefix for the files that are created. | ||
99 | Defaults to no prefix. | ||
100 | <dt>--sort-ram-size=<size> | ||
101 | <dd>Specifies the amount of RAM (in MB) to use for sorting the data. If not | ||
102 | amb | 2141 | specified then 256 MB will be used in slim mode or 1024 MB otherwise. |
103 | amb | 991 | <dt>--sort-threads=<number> |
104 | <dd>The number of threads to use for data sorting (the sorting memory is | ||
105 | amb | 1023 | shared between the threads - too many threads and not enough memory will |
106 | reduce the performance). | ||
107 | amb | 577 | <dt>--tmpdir=<dirname> |
108 | <dd>Specifies the name of the directory to store the temporary disk files. If | ||
109 | not specified then it defaults to either the value of the --dir option or the | ||
110 | current directory. | ||
111 | amb | 953 | <dt>--tagging=<filename> |
112 | <dd>Sets the filename containing the list of tagging rules in XML format for | ||
113 | the parsing the input files. If the file doesn't exist then dirname, prefix | ||
114 | amb | 2049 | and "tagging.xml" will be combined and used, if that doesn't exist then the |
115 | file '/usr/local/share/routino/tagging.xml' (or custom installation | ||
116 | amb | 953 | location) will be used. |
117 | amb | 586 | <dt>--loggable |
118 | <dd>Print progress messages that are suitable for logging to a file; normally | ||
119 | amb | 737 | an incrementing counter is printed which is more suitable for real-time |
120 | amb | 586 | display than logging. |
121 | amb | 982 | <dt>--logtime |
122 | amb | 1598 | <dd>Print the elapsed time for each processing step (minutes, seconds and milliseconds). |
123 | <dt>--logmemory | ||
124 | <dd>Print the maximum allocated and mapped memory for each processing step (MBytes). | ||
125 | amb | 810 | <dt>--errorlog[=<name>] |
126 | <dd>Log OSM parsing and processing errors to 'error.log' or the specified file | ||
127 | amb | 1120 | name (the '--dir' and '--prefix' options are applied). If the --append |
128 | option is used then the existing log file will be appended, otherwise a new | ||
129 | amb | 1396 | one will be created. If the --keep option is also used a geographically |
130 | searchable database of error logs is created for use in the visualiser. | ||
131 | amb | 953 | <dt>--parse-only |
132 | amb | 1120 | <dd>Parse the input files and store the data in intermediate files but don't |
133 | process the data into a routing database. This option must be used with the | ||
134 | --append option for all except the first file. | ||
135 | amb | 953 | <dt>--process-only |
136 | amb | 1120 | <dd>Don't read in any files but process the existing intermediate files |
137 | created by using the --parse-only option. | ||
138 | <dt>--append | ||
139 | <dd>Parse the input file and append the result to the existing intermediate | ||
140 | amb | 1140 | files; the appended file can be either an OSM file or an OSC change file. |
141 | amb | 1167 | <dt>--keep |
142 | amb | 1136 | <dd>Store a set of intermediate files after parsing the OSM files, sorting and |
143 | amb | 1157 | removing duplicates; this allows appending an OSC file and re-processing |
144 | later. | ||
145 | amb | 1140 | <dt>--changes |
146 | <dd>This option indicates that the data being processed contains one or more | ||
147 | OSC (OSM changes) files, they must be applied in time sequence if more than | ||
148 | one is used. This option implies --append when parsing data files and | ||
149 | amb | 1167 | --keep when processing data. |
150 | amb | 577 | <dt>--max-iterations=<number> |
151 | <dd>The maximum number of iterations to use when generating super-nodes and | ||
152 | amb | 861 | super-segments. Defaults to 5 which is normally enough. |
153 | amb | 975 | <dt>--prune-none |
154 | <dd>Disable the prune options below, they can be re-enabled by adding them to | ||
155 | the command line after this option. | ||
156 | <dt>--prune-isolated=<length> | ||
157 | amb | 1117 | <dd>Remove the access permissions for a transport type from small disconnected |
158 | amb | 1391 | groups of segments and remove the segments if they end up with no access |
159 | amb | 1117 | permission (defaults to removing groups under 500m). |
160 | amb | 975 | <dt>--prune-short=<length> |
161 | <dd>Remove short segments (defaults to removing segments up to a maximum | ||
162 | length of 5m). | ||
163 | <dt>--prune-straight=<length> | ||
164 | <dd>Remove nodes in almost straight highways (defaults to removing nodes up to | ||
165 | 3m offset from a straight line). | ||
166 | amb | 1227 | <dt><filename.osm>, <filename.osc>, <filename.pbf>, <filename.o5m>, <filename.o5c> |
167 | amb | 1224 | <dd>Specifies the filename(s) to read data from. Filenames ending '.pbf' will |
168 | amb | 1227 | be read as PBF, filenames ending in '.o5m' or '.o5c' will be read as |
169 | O5M/O5C, otherwise as XML. Filenames ending '.bz2' will be bzip2 | ||
170 | amb | 1224 | uncompressed (if bzip2 support compiled in). Filenames ending '.gz' will be |
171 | amb | 1514 | gzip uncompressed (if gzip support compiled in). Filenames ending '.xz' |
172 | will be xz uncompressed (if xz support compiled in). | ||
173 | amb | 577 | </dl> |
174 | |||
175 | <p> | ||
176 | amb | 2141 | <i>Note: It is recommended use the <tt>--sort-ram-size</tt> and |
177 | <tt>--sort-threads</tt> options because they can make a significant | ||
178 | reduction in the amount of time that it takes to create the database. | ||
179 | Selection of the values to use will depend on the computer being used | ||
180 | and the size of the dataset being processed. Selecting half the | ||
181 | number of CPU cores and half the amount of available RAM is a | ||
182 | reasonable starting point.</i> | ||
183 | amb | 1224 | |
184 | <p> | ||
185 | amb | 1120 | Example usage 1: |
186 | amb | 577 | |
187 | <pre class="boxed"> | ||
188 | amb | 1120 | planetsplitter --dir=data --prefix=gb great_britain.osm |
189 | amb | 577 | </pre> |
190 | |||
191 | This will generate the output files 'data/gb-nodes.mem', 'data/gb-segments.mem' | ||
192 | amb | 1120 | and 'data/gb-ways.mem'. Multiple filenames can be specified on the command |
193 | line and they will all be read in, combined and processed together. | ||
194 | amb | 577 | |
195 | amb | 1120 | <p> |
196 | Example usage 2: | ||
197 | amb | 577 | |
198 | amb | 1120 | <pre class="boxed"> |
199 | planetsplitter --dir=data --prefix=gb --parse-only great_britain_part1.osm | ||
200 | planetsplitter --dir=data --prefix=gb --parse-only --append great_britain_part2.osm | ||
201 | planetsplitter --dir=data --prefix=gb --parse-only --append ... | ||
202 | planetsplitter --dir=data --prefix=gb --process-only | ||
203 | </pre> | ||
204 | |||
205 | This will generate the same output files as the first example but parsing the | ||
206 | input files is performed separately from the data processing. The first file | ||
207 | read in must not use the --append option but the later ones must. | ||
208 | |||
209 | amb | 1140 | <p> |
210 | Example usage 3: | ||
211 | amb | 1120 | |
212 | amb | 1140 | <pre class="boxed"> |
213 | amb | 1224 | planetsplitter --dir=data --prefix=gb --keep great_britain.osm |
214 | amb | 1140 | |
215 | planetsplitter --dir=data --prefix=gb --changes great_britain.osc | ||
216 | </pre> | ||
217 | |||
218 | This will generate the same output files as the first example. The first | ||
219 | command will process the complete file and keep some intermediate data for | ||
220 | later. The second command will apply a set of changes to the stored | ||
221 | intermediate data and keep the updated intermediate files for repeating this | ||
222 | step later with more change data. | ||
223 | <p> | ||
224 | The parsing and processing can be split into multiple commands as it was in | ||
225 | amb | 1167 | example 2 with the --keep option used with --process-only for the initial OSM |
226 | file(s) and the --changes option used with --parse-only or --process-only for | ||
227 | every OSC file. | ||
228 | amb | 1140 | |
229 | |||
230 | amb | 1474 | <h3 id="H_1_1_2">router</h3> |
231 | amb | 577 | |
232 | This program performs the calculation of the optimum routes using the database | ||
233 | generated by the planetsplitter program. | ||
234 | |||
235 | <pre class="boxed"> | ||
236 | amb | 1797 | Usage: router [--version] |
237 | [--help | --help-profile | --help-profile-xml | | ||
238 | amb | 577 | --help-profile-json | --help-profile-perl ] |
239 | [--dir=<dirname>] [--prefix=<name>] | ||
240 | [--profiles=<filename>] [--translations=<filename>] | ||
241 | [--exact-nodes-only] | ||
242 | amb | 1600 | [--quiet | [--loggable] [--logtime] [--logmemory]] |
243 | amb | 577 | [--output-html] |
244 | [--output-gpx-track] [--output-gpx-route] | ||
245 | [--output-text] [--output-text-all] | ||
246 | amb | 1465 | [--output-none] [--output-stdout] |
247 | amb | 577 | [--profile=<name>] |
248 | [--transport=<transport>] | ||
249 | [--shortest | --quickest] | ||
250 | --lon1=<longitude> --lat1=<latitude> | ||
251 | --lon2=<longitude> --lon2=<latitude> | ||
252 | [ ... --lon99=<longitude> --lon99=<latitude>] | ||
253 | amb | 1504 | [--reverse] [--loop] |
254 | amb | 675 | [--heading=<bearing>] |
255 | amb | 577 | [--highway-<highway>=<preference> ...] |
256 | [--speed-<highway>=<speed> ...] | ||
257 | [--property-<property>=<preference> ...] | ||
258 | amb | 622 | [--oneway=(0|1)] [--turns=(0|1)] |
259 | amb | 577 | [--weight=<weight>] |
260 | [--height=<height>] [--width=<width>] [--length=<length>] | ||
261 | </pre> | ||
262 | |||
263 | <dl> | ||
264 | amb | 1797 | <dt>--version |
265 | <dd>Print the version of Routino. | ||
266 | amb | 577 | <dt>--help |
267 | <dd>Prints out the help information. | ||
268 | <dt>--help-profile | ||
269 | <dd>Prints out the selected transport profile (type, speed limits, highway | ||
270 | preferences etc.) | ||
271 | <dt>--help-profile-xml | ||
272 | <dd>Prints out all the loaded profiles as an XML file in the same format that | ||
273 | can be loaded in. | ||
274 | <dt>--help-profile-json | ||
275 | <dd>Prints out all the loaded profiles in JavaScript Object Notation (JSON) | ||
276 | format for use in the interactive webpage. | ||
277 | <dt>--help-profile-perl | ||
278 | <dd>Prints out all the loaded profiles as a Perl object for use in the router | ||
279 | CGI. | ||
280 | <dt>--dir=<dirname> | ||
281 | <dd>Sets the directory name in which to read the local database. | ||
282 | Defaults to the current directory. | ||
283 | <dt>--prefix=<name> | ||
284 | <dd>Sets the filename prefix for the files in the local database. | ||
285 | Defaults to no prefix. | ||
286 | <dt>--profiles=<filename> | ||
287 | amb | 585 | <dd>Sets the filename containing the list of routing profiles in XML format. |
288 | If the file doesn't exist then dirname, prefix and "profiles.xml" will be | ||
289 | combined and used, if that doesn't exist then the file | ||
290 | '/usr/local/share/routino/profiles.xml' (or custom installation location) | ||
291 | will be used. | ||
292 | amb | 577 | <dt>--translations=<filename> |
293 | <dd>Sets the filename containing the list of translations in XML format for | ||
294 | the output files. If the file doesn't exist then dirname, prefix and | ||
295 | amb | 585 | "translations.xml" will be combined and used, if that doesn't exist then the |
296 | file '/usr/local/share/routino/translations.xml' (or custom installation | ||
297 | location) will be used. | ||
298 | amb | 577 | <dt>--exact-nodes-only |
299 | <dd>When processing the specified latitude and longitude points only select | ||
300 | the nearest node instead of finding the nearest point within a segment | ||
301 | (quicker but less accurate unless the points are already near nodes). | ||
302 | amb | 1600 | <dt>--quiet |
303 | <dd>Don't generate any screen output while running (useful for running in a script). | ||
304 | amb | 586 | <dt>--loggable |
305 | <dd>Print progress messages that are suitable for logging to a file; normally | ||
306 | amb | 737 | an incrementing counter is printed which is more suitable for real-time |
307 | amb | 586 | display than logging. |
308 | amb | 1600 | <dt>--logtime |
309 | <dd>Print the elapsed time for each processing step (minutes, seconds and milliseconds). | ||
310 | <dt>--logmemory | ||
311 | <dd>Print the maximum allocated and mapped memory for each processing step (MBytes). | ||
312 | amb | 577 | <dt>--language=<lang> |
313 | <dd>Select the language specified from the file of translations. If this | ||
314 | option is not given and the file exists then the first language in the file | ||
315 | will be used. If this option is not given and no file exists the | ||
316 | compiled-in default language (English) will be used. | ||
317 | <dt>--output-html | ||
318 | <dt>--output-gpx-track | ||
319 | <dt>--output-gpx-route | ||
320 | <dt>--output-text | ||
321 | <dt>--output-text-all | ||
322 | <dd>Generate the selected output file formats (HTML, GPX track file, GPX route | ||
323 | file, plain text route and/or plain text with all nodes). If no output is | ||
324 | specified then all are generated, specifying any automatically disables those | ||
325 | not specified. | ||
326 | <dt>--output-none | ||
327 | <dd>Do not generate any output or read in any translations files. | ||
328 | amb | 1465 | <dt>--output-stdout |
329 | <dd>Write to stdout instead of a file (requires exactly one output format | ||
330 | option, implies '--quiet'). | ||
331 | amb | 577 | <dt>--profile=<name> |
332 | <dd>Specifies the name of the profile to use. | ||
333 | <dt>--transport=<transport> | ||
334 | <dd>Select the type of transport to use, <transport> can be set to: | ||
335 | <ul> | ||
336 | <li>foot = Foot | ||
337 | <li>horse = Horse | ||
338 | <li>wheelchair = Wheelchair | ||
339 | <li>bicycle = Bicycle | ||
340 | amb | 1243 | <li>moped = Moped (Small motorcycle, limited speed) |
341 | <li>motorcycle = Motorcycle | ||
342 | amb | 577 | <li>motorcar = Motorcar |
343 | <li>goods = Goods (Small lorry, van) | ||
344 | <li>hgv = HGV (Heavy Goods Vehicle - large lorry) | ||
345 | <li>psv = PSV (Public Service Vehicle - bus, coach) | ||
346 | </ul> | ||
347 | Defaults to 'motorcar', this option also selects the default profile | ||
348 | information if the '--profile' option is not given and a profile matching | ||
349 | the transport name is found. | ||
350 | <dt>--shortest | ||
351 | <dd>Find the shortest route between the waypoints. | ||
352 | <dt>--quickest | ||
353 | <dd>Find the quickest route between the waypoints. | ||
354 | <dt>--lon1=<longitude>, --lat1=<latitude> | ||
355 | <dt>--lon2=<longitude>, --lat2=<latitude> | ||
356 | <dt>... --lon99=<longitude>, --lat99=<latitude> | ||
357 | <dd>The location of the waypoints that make up the start, middle and end | ||
358 | points of the route. Up to 99 waypoints can be specified and the route will | ||
359 | pass through each of the specified ones in sequence. The algorithm will use | ||
360 | the closest node or point within a segment that allows the specified traffic | ||
361 | type. | ||
362 | amb | 1503 | <dt>--reverse |
363 | <dd>Find a route between the waypoints in reverse order. | ||
364 | amb | 1504 | <dt>--loop |
365 | <dd>Find a route that returns to the first waypoint after the last one. | ||
366 | amb | 675 | <dt>--heading=<bearing> |
367 | <dd>Specifies the initial direction of travel at the start of the route (from | ||
368 | amb | 737 | the lowest numbered waypoint) as a compass bearing from 0 to 360 degrees. |
369 | amb | 577 | <dt>--highway-<highway>=<preference> |
370 | <dd>Selects the percentage preference for using each particular type of | ||
371 | highway. The value of <highway> can be selected from: | ||
372 | <ul> | ||
373 | <li>motorway = Motorway | ||
374 | <li>trunk = Trunk | ||
375 | <li>primary = Primary | ||
376 | <li>secondary = Secondary | ||
377 | <li>tertiary = Tertiary | ||
378 | <li>unclassified = Unclassified | ||
379 | <li>residential = Residential | ||
380 | <li>service = Service | ||
381 | <li>track = Track | ||
382 | <li>cycleway = Cycleway | ||
383 | <li>path = Path | ||
384 | <li>steps = Steps | ||
385 | amb | 586 | <li>ferry = Ferry |
386 | amb | 577 | </ul> |
387 | Default value depends on the profile selected by the --transport option. | ||
388 | <dt>--speed-<highway>=<speed> | ||
389 | <dd>Selects the speed limit in km/hour for each type of highway. Default | ||
390 | value depends on the profile selected by the --transport option. | ||
391 | <dt>--property-<property>=<preference> | ||
392 | <dd>Selects the percentage preference for using each particular highway | ||
393 | property | ||
394 | The value of <property> can be selected from: | ||
395 | <ul> | ||
396 | amb | 585 | <li>paved = Paved (suitable for normal wheels) |
397 | <li>multilane = Multiple lanes | ||
398 | <li>bridge = Bridge | ||
399 | <li>tunnel = Tunnel | ||
400 | <li>footroute = A route marked for foot travel | ||
401 | <li>bicycleroute = A route marked for bicycle travel | ||
402 | amb | 577 | </ul> |
403 | Default value depends on the profile selected by the --transport option. | ||
404 | <dt>--oneway=[0|1] | ||
405 | <dd>Selects if the direction of oneway streets are to be obeyed (useful to not | ||
406 | obey them when walking). Default value depends on the profile selected by | ||
407 | the --transport option. | ||
408 | amb | 622 | <dt>--turns=[0|1] |
409 | <dd>Selects if turn restrictions are to be obeyed (useful to not obey them | ||
410 | when walking). Default value depends on the profile selected by the | ||
411 | --transport option. | ||
412 | amb | 577 | <dt>--weight=<weight> |
413 | <dd>Specifies the weight of the mode of transport in tonnes; ensures that the | ||
414 | weight limit on the highway is not exceeded. Default value depends on the | ||
415 | profile selected by the --transport option. | ||
416 | <dt>--height=<height> | ||
417 | <dd>Specifies the height of the mode of transport in metres; ensures that the | ||
418 | height limit on the highway is not exceeded. Default value depends on the | ||
419 | profile selected by the --transport option. | ||
420 | <dt>--width=<width> | ||
421 | <dd>Specifies the width of the mode of transport in metres; ensures that the | ||
422 | width limit on the highway is not exceeded. Default value depends on the | ||
423 | profile selected by the --transport option. | ||
424 | <dt>--length=<length> | ||
425 | <dd>Specifies the length of the mode of transport in metres; ensures that the | ||
426 | length limit on the highway is not exceeded. Default value depends on the | ||
427 | profile selected by the --transport option. | ||
428 | </dl> | ||
429 | |||
430 | <p> | ||
431 | The meaning of the <preference> parameter in the command line options is | ||
432 | slightly different for the highway preferences and the property preferences. | ||
433 | For the highway preference consider the choice between two possible highways | ||
434 | between the start and finish when looking for the shortest route. If highway A | ||
435 | has a preference of 100% and highway B has a preference of 90% then highway A | ||
436 | will be chosen even if it is up to 11% longer (100/90 = 111%). For the highway | ||
437 | properties each highway either has a particular property or not. If the | ||
438 | amb | 585 | preference for the property is 60% then a highway with the property has a |
439 | preference of 77% (sqrt(60%)) and one without has a preference of 63% | ||
440 | (sqrt(100-60%)). A highway with the property will be chosen even if it is up to | ||
441 | 22% longer than one without the property (77/63 = 122%). The overall preference | ||
442 | for each highway segment is the product of the preference for the highway type | ||
443 | and all of the preferences for the highway properties. | ||
444 | amb | 577 | |
445 | <p> | ||
446 | amb | 1243 | Example usage (motorcycle journey, scenic route, not very fast): |
447 | amb | 577 | |
448 | <pre class="boxed"> | ||
449 | amb | 1243 | router --dir=data --prefix=gb --transport=motorcycle --highway-motorway=0 \ |
450 | amb | 1120 | --highway-trunk=0 --speed-primary=80 --speed-secondary=80 --quickest |
451 | amb | 577 | </pre> |
452 | |||
453 | This will use the files 'data/gb-nodes.mem', 'data/gb-segments.mem' and | ||
454 | amb | 1243 | 'data/gb-ways.mem' to find the quickest route by motorcycle not using motorways |
455 | amb | 577 | or trunk roads and not exceeding 80 km/hr. |
456 | |||
457 | |||
458 | amb | 1474 | <h3 id="H_1_1_3">filedumper</h3> |
459 | amb | 577 | |
460 | This program is used to extract statistics from the database, extract particular | ||
461 | information for visualisation purposes or for dumping the database contents. | ||
462 | |||
463 | <pre class="boxed"> | ||
464 | amb | 1797 | Usage: filedumper [--version] |
465 | [--help] | ||
466 | amb | 577 | [--dir=<dirname>] [--prefix=<name>] |
467 | [--statistics] | ||
468 | [--visualiser --latmin=<latmin> --latmax=<latmax> | ||
469 | --lonmin=<lonmin> --lonmax=<lonmax> | ||
470 | --data=<data-type>] | ||
471 | [--dump [--node=<node> ...] | ||
472 | [--segment=<segment> ...] | ||
473 | amb | 592 | [--way=<way> ...] |
474 | amb | 1323 | [--turn-relation=<relation> ...] |
475 | amb | 1330 | [--errorlog=<number> ...]] |
476 | amb | 577 | [--dump-osm [--no-super] |
477 | [--latmin=<latmin> --latmax=<latmax> | ||
478 | --lonmin=<lonmin> --lonmax=<lonmax>]] | ||
479 | amb | 1458 | [--dump-visualiser [--data=node<node>] |
480 | [--data=segment<segment>] | ||
481 | [--data=turn-relation<rel>] | ||
482 | [--data=errorlog<number>]] | ||
483 | amb | 577 | </pre> |
484 | |||
485 | <dl> | ||
486 | amb | 1797 | <dt>--version |
487 | <dd>Print the version of Routino. | ||
488 | amb | 577 | <dt>--help |
489 | <dd>Prints out the help information. | ||
490 | <dt>--dir=<dirname> | ||
491 | <dd>Sets the directory name in which to read the local database. | ||
492 | Defaults to the current directory. | ||
493 | <dt>--prefix=<name> | ||
494 | <dd>Sets the filename prefix for the files in the local database. | ||
495 | <dt>--statistics | ||
496 | <dd>Prints out statistics about the database files. | ||
497 | <dt>--visualiser | ||
498 | <dd>Selects a data visualiser mode which will output a set of data according | ||
499 | to the other parameters below. | ||
500 | <dl> | ||
501 | <dt>--latmin=<latmin> --latmax=<latmax> | ||
502 | <dd>The range of latitudes to print the data for. | ||
503 | <dt>--lonmin=<lonmin> --lonmax=<lonmax> | ||
504 | <dd>The range of longitudes to print the data for. | ||
505 | <dt>--data=<data-type> | ||
506 | <dd>The type of data to output, <data-type> can be selected from: | ||
507 | <ul> | ||
508 | amb | 1002 | <li>junctions = segment count at each junction. |
509 | <li>super = super-node and super-segments. | ||
510 | amb | 1560 | <li>waytype-* = segments of oneway, cyclebothways or roundabout type. |
511 | <li>highway-* = segments of the specified highway type | ||
512 | amb | 1003 | (e.g. highway-primary to display segments ofprimary roads). |
513 | amb | 1002 | <li>transport-* = segments allowing the specified transport type |
514 | (e.g. transport-foot to display segments accessible on foot). | ||
515 | <li>turns = turn restrictions. | ||
516 | <li>speed = speed limits. | ||
517 | <li>weight = weight limits. | ||
518 | <li>height = height limits. | ||
519 | <li>width = width limits. | ||
520 | <li>length = length limits. | ||
521 | amb | 1248 | <li>property-* = segments having the specified property |
522 | (e.g. property-paved to display segments of paved highway). | ||
523 | amb | 1323 | <li>errorlogs = errors logged during parsing. |
524 | amb | 577 | </ul> |
525 | </dl> | ||
526 | <dt>--dump | ||
527 | <dd>Selects a data dumping mode which allows looking at individual items in | ||
528 | the databases (specifying 'all' instead of a number dumps all of them). | ||
529 | amb | 601 | More than one of the following parameters can be specified on the command |
530 | line. | ||
531 | amb | 577 | <dl> |
532 | <dt>--node=<node> | ||
533 | <dd>Prints the information about the selected node number (internal | ||
534 | number, not the node id number in the original source file). | ||
535 | <dt>--segment=<segment> | ||
536 | <dd>Prints the information about the selected segment number. | ||
537 | <dt>--way=<way> | ||
538 | <dd>Prints the information about the selected way number (internal | ||
539 | number, not the way id number in the original source file). | ||
540 | amb | 601 | <dt>--turn-relation=<relation> |
541 | <dd>Prints the information about the selected turn relation number | ||
542 | (internal number, not the relation id number in the original source | ||
543 | file). | ||
544 | amb | 1323 | <dt>--errorlog=<number> |
545 | <dd>Prints the information about the selected error log that was stored | ||
546 | when the data was parsed. | ||
547 | amb | 577 | </dl> |
548 | <dt>--osm-dump | ||
549 | <dd>Dumps the contents of the database as an OSM format XML file, the whole | ||
550 | database will be dumped unless the latitude and longitude ranges are | ||
551 | specified. | ||
552 | <dl> | ||
553 | <dt>--no-super | ||
554 | <dd>The super segments will not be output. | ||
555 | <dt>--latmin=<latmin> --latmax=<latmax> | ||
556 | <dd>The range of latitudes to dump the data for. | ||
557 | <dt>--lonmin=<lonmin> --lonmax=<lonmax> | ||
558 | <dd>The range of longitudes to dump the data for. | ||
559 | </dl> | ||
560 | amb | 1330 | <dt>--dump-visualiser |
561 | <dd>Dumps the contents of the database as HTML formatted items for display in | ||
562 | the visualiser web page. | ||
563 | <dl> | ||
564 | <dt>--data=node<node> | ||
565 | <dd>Prints the information about the selected node number (internal | ||
566 | node number, not from the original source file). | ||
567 | <dt>--data=segment<segment> | ||
568 | <dd>Prints the information about the selected segment number as if it was | ||
569 | a way (internal segment number, unrelated to original source file). | ||
570 | <dt>--data=turn-relation<relation> | ||
571 | <dd>Prints the information about the selected turn relation number | ||
572 | (internal turn relation number, not from the original source file). | ||
573 | <dt>--data=errorlog<number> | ||
574 | <dd>Prints the information about the selected error log that was stored | ||
575 | when the data was parsed. | ||
576 | </dl> | ||
577 | amb | 577 | </dl> |
578 | |||
579 | |||
580 | amb | 1474 | <h3 id="H_1_1_4">filedumperx</h3> |
581 | amb | 577 | |
582 | amb | 1149 | This program is a modified version of filedumper that will dump out the contents |
583 | of the intermediate data that is saved by planetsplitter after processing using | ||
584 | amb | 1167 | the --keep or --changes option. This is intended for test purposes only and |
585 | amb | 1149 | gives no useful information about the routing database. |
586 | |||
587 | <pre class="boxed"> | ||
588 | amb | 1797 | Usage: filedumperx [--version] |
589 | [--help] | ||
590 | amb | 1340 | [--dir=<dirname>] [--prefix=<name>] |
591 | [--dump [--nodes] | ||
592 | [--ways] | ||
593 | [--route-relations] | ||
594 | [--turn-relations]] | ||
595 | amb | 1149 | </pre> |
596 | |||
597 | <dl> | ||
598 | amb | 1797 | <dt>--version |
599 | <dd>Print the version of Routino. | ||
600 | amb | 1149 | <dt>--help |
601 | <dd>Prints out the help information. | ||
602 | <dt>--dir=<dirname> | ||
603 | <dd>Sets the directory name in which to read the local database. | ||
604 | Defaults to the current directory. | ||
605 | <dt>--prefix=<name> | ||
606 | <dd>Sets the filename prefix for the files in the local database. | ||
607 | <dt>--dump | ||
608 | <dd>Dumps the complete set of data in the intermediate files that are written | ||
609 | amb | 1167 | by planetsplitter using the --keep or --changes options. |
610 | amb | 1149 | <dl> |
611 | <dt>--nodes | ||
612 | <dd>Dumps the node data. | ||
613 | <dt>--ways | ||
614 | <dd>Dumps the way data. | ||
615 | <dt>--route-relations | ||
616 | <dd>Dumps the route relation data. | ||
617 | <dt>--turn-relations | ||
618 | <dd>Dumps the turn relation data. | ||
619 | </dl> | ||
620 | </dl> | ||
621 | |||
622 | amb | 577 | </div> |
623 | |||
624 | <!-- Content End --> | ||
625 | |||
626 | <!-- Footer Start --> | ||
627 | |||
628 | amb | 1469 | <div class="footer"> |
629 | amb | 577 | |
630 | <address> | ||
631 | amb | 1267 | © Andrew M. Bishop - <a href="http://www.routino.org/">http://www.routino.org/</a> |
632 | amb | 577 | </address> |
633 | |||
634 | </div> | ||
635 | |||
636 | <!-- Footer End --> | ||
637 | |||
638 | amb | 1469 | </body> |
639 | amb | 577 | |
640 | amb | 1469 | </html> |