Routino SVN Repository Browser

Check out the latest version of Routino: svn co http://routino.org/svn/trunk routino

ViewVC logotype

Contents of /branches/destination-access/doc/OUTPUT.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1807 - (show annotations) (download)
Wed Sep 23 18:20:13 2015 UTC (9 years, 5 months ago) by amb
File MIME type: text/plain
File size: 12736 byte(s)
Merge the trunk changes back into the destination-access branch.

1 Routino : Output
2 ================
3
4
5 There are three different formats of output from the router, HTML, GPX
6 (GPS eXchange) XML format and plain text with a total of five possible
7 output files:
8 * HTML route instructions for each interesting junction.
9 * GPX track file containing every node.
10 * GPX route file with waypoints at interesting junctions.
11 * Plain text description with the interesting junctions.
12 * Plain text file with every node.
13
14 The "interesting junctions" referred to above are junctions where the
15 route changes to a different type of highway, more than two highways of
16 the same type meet, or where the route meets but does not take a more
17 major highway. When the route follows a major road this definition
18 eliminates all junctions with minor roads.
19
20 The output files are written to the current directory and are named
21 depending on the selection of shortest or quickest route. For the
22 shortest route the file names are "shortest.html",
23 "shortest-track.gpx", "shortest-route.gpx", "shortest.txt" and
24 "shortest-all.txt", for the quickest route the names are
25 "quickest.html", "quickest-track.gpx", "quickest-route.gpx",
26 "quickest.txt" and "quickest-all.txt".
27
28 The HTML file and GPX files are written out according to the selected
29 language using the translations contained in the translations.xml
30 configuration file. The text files contains untranslated header lines
31 (in English) but the data is translated.
32
33
34 HTML Route Instructions
35 -----------------------
36
37 The HTML route instructions file contains one line for the description
38 of each of the interesting junctions in the route and one line for each
39 of the highways that connect them. The coordinates are also included in
40 the file but are not visible because of the style definitions.
41
42 An example HTML file output is below (some parts are missing, for
43 example the style definitions):
44
45 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
46 <HTML>
47 <!-- Creator : Routino - http://www.routino.org/ -->
48 <!-- Source : Based on OpenStreetMap data from http://www.openstreetmap.org/ -->
49 <!-- License : http://www.openstreetmap.org/copyright -->
50 <HEAD>
51 <TITLE>Shortest Route</TITLE>
52 ...
53 </HEAD>
54 <BODY>
55 <H1>Shortest Route</H1>
56 <table>
57 <tr class='c'><td class='l'>1:<td class='r'>51.524658 -0.127877
58 <tr class='n'><td class='l'>Start:<td class='r'>At <span class='w'>Waypoint</span>, head <span class='b'>South-East</span>
59 <tr class='s'><td class='l'>Follow:<td class='r'><span class='h'>Woburn Place (A4200)</span> for <span class='d'>0.251 km, 0.3 min</span> [<span class='j'>0.3 km, 0 minutes</span>]
60 <tr class='c'><td class='l'>2:<td class='r'>51.522811 -0.125781
61 <tr class='n'><td class='l'>At:<td class='r'>Junction, go <span class='t'>Straight on</span> heading <span class='b'>South-East</span>
62 <tr class='s'><td class='l'>Follow:<td class='r'><span class='h'>Russell Square (A4200)</span> for <span class='d'>0.186 km, 0.2 min</span> [<span class='j'>0.4 km, 1 minutes</span>]
63 <tr class='c'><td class='l'>3:<td class='r'>51.521482 -0.124123
64 <tr class='n'><td class='l'>At:<td class='r'>Junction, go <span class='t'>Straight on</span> heading <span class='b'>South-East</span>
65 <tr class='s'><td class='l'>Follow:<td class='r'><span class='h'>Southampton Row (A4200)</span> for <span class='d'>0.351 km, 0.4 min</span> [<span class='j'>0.8 km, 1 minutes</span>]
66 ...
67 <tr class='c'><td class='l'>21:<td class='r'>51.477678 -0.106792
68 <tr class='n'><td class='l'>At:<td class='r'>Junction, go <span class='t'>Slight left</span> heading <span class='b'>South-East</span>
69 <tr class='s'><td class='l'>Follow:<td class='r'><span class='h'>Vassall Road</span> for <span class='d'>0.138 km, 0.2 min</span> [<span class='j'>6.3 km, 6 minutes</span>]
70 <tr class='c'><td class='l'>22:<td class='r'>51.478015 -0.104870
71 <tr class='n'><td class='l'>At:<td class='r'>Junction, go <span class='t'>Straight on</span> heading <span class='b'>East</span>
72 <tr class='s'><td class='l'>Follow:<td class='r'><span class='h'>Vassall Road</span> for <span class='d'>0.087 km, 0.1 min</span> [<span class='j'>6.4 km, 6 minutes</span>]
73 <tr class='c'><td class='l'>23:<td class='r'>51.478244 -0.103651
74 <tr class='n'><td class='l'>Stop:<td class='r'>At <span class='w'>Waypoint</span>
75 <tr class='t'><td class='l'>Total:<td class='r'><span class='j'>6.4 km, 6 minutes</span>
76 </table>
77 </BODY>
78 </HTML>
79
80
81 GPX Track File
82 --------------
83
84 The GPX track file contains a track with all of the individual nodes
85 that the route passes through.
86
87 An example GPX track file output is below:
88
89 <?xml version="1.0" encoding="UTF-8"?>
90 <gpx version="1.1" creator="Routino" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
91 xmlns="http://www.topografix.com/GPX/1/1"
92 xsi:schemaLocation="http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd">
93 <metadata>
94 <desc>Creator : Routino - http://www.routino.org/</desc>
95 <copyright author="Based on OpenStreetMap data from http://www.openstreetmap.org/">
96 <license>http://www.openstreetmap.org/copyright</license>
97 </copyright>
98 </metadata>
99 <trk>
100 <name>Shortest route</name>
101 <desc>Shortest route between 'start' and 'finish' waypoints</desc>
102 <trkpt lat="51.524658" lon="-0.127877"/>
103 <trkpt lat="51.523768" lon="-0.126918"/>
104 <trkpt lat="51.522811" lon="-0.125781"/>
105 ...
106 <trkpt lat="51.478015" lon="-0.104870"/>
107 <trkpt lat="51.478127" lon="-0.104174"/>
108 <trkpt lat="51.478244" lon="-0.103651"/>
109 </trkseg>
110 </trk>
111 </gpx>
112
113
114 GPX Route File
115 --------------
116
117 The GPX route file contains a route (ordered set of waypoints) with all
118 of the interesting junctions that the route passes through and a
119 description of the route to take from that point.
120
121 An example GPX route file output is below:
122
123 <?xml version="1.0" encoding="UTF-8"?>
124 <gpx version="1.1" creator="Routino" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
125 xmlns="http://www.topografix.com/GPX/1/1"
126 xsi:schemaLocation="http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd">
127 <metadata>
128 <desc>Creator : Routino - http://www.routino.org/</desc>
129 <copyright author="Based on OpenStreetMap data from http://www.openstreetmap.org/">
130 <license>http://www.openstreetmap.org/copyright</license>
131 </copyright>
132 </metadata>
133 <rte>
134 <name>Shortest route</name>
135 <desc>Shortest route between 'start' and 'finish' waypoints</desc>
136 <rtept lat="51.524658" lon="-0.127877">
137 <name>START</name>
138 <desc>South-East on 'Woburn Place (A4200)' for 0.251 km, 0.3 min</desc>
139 </rtept>
140 <rtept lat="51.522811" lon="-0.125781">
141 <name>TRIP001</name>
142 <desc>South-East on 'Russell Square (A4200)' for 0.186 km, 0.2 min</desc>
143 </rtept>
144 <rtept lat="51.521482" lon="-0.124123">
145 <name>TRIP002</name>
146 <desc>South-East on 'Southampton Row (A4200)' for 0.351 km, 0.4 min</desc>
147 </rtept>
148 ...
149 <rtept lat="51.477678" lon="-0.106792">
150 <name>TRIP020</name>
151 <desc>South-East on 'Vassall Road' for 0.138 km, 0.2 min</desc>
152 </rtept>
153 <rtept lat="51.478015" lon="-0.104870">
154 <name>TRIP021</name>
155 <desc>East on 'Vassall Road' for 0.087 km, 0.1 min</desc>
156 </rtept>
157 <rtept lat="51.478244" lon="-0.103651">
158 <name>FINISH</name>
159 <desc>Total Journey 6.4 km, 6 minutes</desc>
160 </rtept>
161 </rte>
162 </gpx>
163
164
165 Text File
166 ---------
167
168 The text file format contains one entry for all of the interesting
169 junctions in the route and is intended to be easy to interpret, for
170 example for creating other output formats.
171
172 An example text file output is below:
173
174 # Creator : Routino - http://www.routino.org/
175 # Source : Based on OpenStreetMap data from http://www.openstreetmap.org/
176 # License : http://www.openstreetmap.org/copyright
177 #
178 #Latitude Longitude Section Section Total Total Point Turn Bearing Highway
179 # Distance Duration Distance Duration Type
180 51.524658 -0.127877 0.000 km 0.0 min 0.0 km 0 min Waypt +3 Woburn Place (A4200)
181 51.522811 -0.125781 0.251 km 0.3 min 0.3 km 0 min Junct +0 +3 Russell Square (A4200)
182 51.521482 -0.124123 0.186 km 0.2 min 0.4 km 1 min Junct +0 +3 Southampton Row (A4200)
183 ...
184 51.477678 -0.106792 0.204 km 0.2 min 6.1 km 5 min Junct +0 +3 Vassall Road
185 51.478015 -0.104870 0.138 km 0.2 min 6.3 km 6 min Junct +0 +2 Vassall Road
186 51.478244 -0.103651 0.087 km 0.1 min 6.4 km 6 min Waypt
187
188 The text file output contains a header (indicated by the lines starting
189 with '#') and then one line for each waypoint or junction. Each line
190 contains the information for the current node and the next segment to
191 be followed. For each of the lines the individual fields contain the
192 following:
193
194 Latitude - Location of the node (degrees)
195
196 Longitude - Location of the node (degrees)
197
198 Section Distance - The distance travelled on the section of the journey
199 that ends at this node.
200
201 Section Duration - The duration of travel on the section of the journey
202 that ends at this node.
203
204 Total Distance - The total distance travelled up to this point.
205
206 Total Duration - The total duration of travel up to this point.
207
208 Point Type - The type of point; either a waypoint Waypt or junction
209 Junct.
210
211 Turn - The direction to turn at this point (missing for the first line
212 since the journey has not started yet and for the last line because it
213 has finished). This can take one of nine values between -4 and +4
214 defined by: 0 = Straight, +2 = Right, -2 = Left and +/-4 = Reverse.
215
216 Bearing - The direction to head from this point (missing for the last
217 line since the journey has finished). This can take one of nine values
218 between -4 and +4 defined by: 0 = North, +2 = East, -2 = West and +/-4
219 = South.
220
221 Highway - The name (or description) of the highway to follow from this
222 point (missing on the last line since the journey has finished).
223
224 The individual items are separated by tabs but some of the items
225 contain spaces as well.
226
227
228 All Nodes Text File
229 -------------------
230
231 The all nodes text file format contains one entry for each of the nodes
232 on the route.
233
234 An example all nodes text file output is below:
235
236 # Creator : Routino - http://www.routino.org/
237 # Source : Based on OpenStreetMap data from http://www.openstreetmap.org/
238 # License : http://www.openstreetmap.org/copyright
239 #
240 #Latitude Longitude Node Type Segment Segment Total Total Speed Bearing Highway
241 # Dist Durat'n Dist Durat'n
242 51.524658 -0.127877 8439703* Waypt 0.000 0.00 0.00 0.0
243 51.523768 -0.126918 8439948* Junct- 0.119 0.15 0.12 0.1 96 146 Woburn Place (A4200)
244 51.522811 -0.125781 8440207* Junct 0.132 0.17 0.25 0.3 96 143 Woburn Place (A4200)
245 ...
246 51.478015 -0.104870 8529638* Change 0.138 0.17 6.26 5.6 48 74 Vassall Road
247 51.478127 -0.104174 8529849* Junct- 0.049 0.04 6.31 5.7 64 75 Vassall Road
248 51.478244 -0.103651 8530008 Waypt 0.038 0.04 6.35 5.7 64 70 Vassall Road
249
250 The all nodes text file output contains a header (indicated by the
251 lines starting with '#') and then one line for each node and the
252 segment that was used to reach it. This file therefore contains exactly
253 the same model as is used internally to define a route (a series of
254 results each of which is a node and the segment leading to it). For
255 each of the lines the individual fields contain the following:
256
257 Latitude - Location of the node in degrees.
258
259 Longitude - Location of the node in degrees.
260
261 Node - The internal node number and an indicator "*" if the node is a
262 super-node.
263
264 Type - The type of point; a waypoint Waypt, important junction Junct,
265 unimportant junction Junct-, change of highway Change or intermediate node
266 Inter.
267
268 Segment Distance - The distance travelled on the segment defined on this
269 line.
270
271 Segment Duration - The duration of travel on the segment defined on this
272 line.
273
274 Total Distance - The total distance travelled up to this point.
275
276 Total Duration - The total duration of travel up to this point.
277
278 Speed - The speed of travel on the segment defined on this line (missing
279 on the first line).
280
281 Bearing - The direction that the segment defined on this line travels in
282 degrees (missing on the first line).
283
284 Highway - The name (or description) of the highway segment (missing on
285 the first line).
286
287
288 --------
289
290 Copyright 2008-2011 Andrew M. Bishop.

Properties

Name Value
cvs:description Documentation about the router output.