1
0
mirror of https://github.com/tumic0/GPXSee.git synced 2024-11-24 03:35:53 +01:00
GPXSee/doc.html

254 lines
11 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>GPXSee - Documentation</title>
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
<link rel="icon" type="image/png" href="css/images/favicon.png"/>
<link rel="stylesheet" href="css/style.css" type="text/css" media="all" />
<!--[if IE 6]><link rel="stylesheet" href="css/ie6.css" type="text/css" media="all" /><![endif]-->
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-110140219-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-110140219-1');
</script>
</head>
<body>
<!-- START PAGE SOURCE -->
<div class="shell">
<div class="shell-b">
<div id="header">
<img src="css/images/gpxsee.png" alt="" class="logo"/><h1 class="logo"><a href="http://www.gpxsee.org">GPXSee</a></h1>
<div id="navigation">
<ul>
<li><a href="index.html">Home</a></li>
<li><a href="gallery.html">Screenshots</a></li>
<li><a href="doc.html" class="active">Documentation</a></li>
<li><a href="index.html#download">Download</a></li>
</ul>
</div>
<div class="cl">&nbsp;</div>
</div>
<div id="main">
<div id="content">
<h2 id="data">Data files</h2>
<p>GPXSee opens GPX, TCX, FIT, KML, IGC, NMEA, OziExplorer (PLT, RTE, WPT) and
<a href="http://www.poi-factory.com/garmin-csv-file-format">Garmin CSV</a>
files, however not all format features are supported for all formats.
Generally, GPXSee supports three kinds of data objects:</p>
<ul>
<li>Tracks</li>
<li>Routes</li>
<li>Waypoints</li>
</ul>
<p>Naturally, if a format supports only a subset of the objects, GPXSee also
supports only this subset. Some formats - especially KML - have support for
a plenty of other data objects like surfaces or even 3D structures. Those are
not supported by GPXSee.</p>
<p>In addition to GPS data, data from the following sensors is supported
by GPXSee:</p>
<ul>
<li>Heart rate</li>
<li>Cadence</li>
<li>Power</li>
<li>Temperature</li>
<li>Gear ratio/shifts (Shimano Di2, SRAM eTap)</li>
</ul>
<h2 id="maps">Maps</h2>
<p>Two kinds of maps are supported by GPXSee - online maps and offline maps.
You may either load them "ad hoc" from the GUI or they can be loaded
automatically at program startup from the following directory:</p>
<table class="config-files">
<tr>
<td class="os">Windows:</td>
<td class="file">C:\Program Files\GPXSee\maps</td>
</tr><tr>
<td class="os">Linux:</td>
<td class="file">/usr/share/gpxsee/maps</td>
</tr><tr>
<td class="os">OS X:</td>
<td class="file">/Applications/GPXSee.app/Contents/Resources/maps</td>
</tr>
</table>
<p>User specific map directories that - when present - override the global map
directory are also supported. The paths are as follows:</p>
<table class="config-files">
<tr>
<td class="os">Windows:</td>
<td class="file">%HOMEPATH%\GPXSee\maps</td>
</tr><tr>
<td class="os">OS X, Linux:</td>
<td class="file">$HOME/.gpxsee/maps</td>
</tr>
</table>
<p>The map directory is recursively searched when loading the maps, so it
may contain an arbitrary directory structure.</p>
<h3 id="online">Online maps</h3>
<p>The mapsource definition file format is based on XML and is fairly simple.
For the formal map source file syntax see the <a href="map/1/map.xsd">mapsource
XSD file</a>. The paragraphs below are a "human-readable" summary of the XSD
syntax/semantics divided by map type.</p>
<h4 id="OSM">OSM/Google tiles</h4>
<p>The root <i>map</i> element contains two mandatory elements - <i>name</i>
and <i>url</i>, and two optional elements - <i>zoom</i> and <i>bounds</i>.
The tile X and Y coordinates are replaced with <code>$x</code> and
<code>$y</code> in the URL and the zoom level is replaced with
<code>$z</code>. An example map source definition file can look like:</p>
<pre>
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;map xmlns="http://www.gpxsee.org/map/1" type="OSM"&gt;
&lt;name&gt;USGS Imagery&lt;/name&gt;
&lt;url&gt;https://navigator.er.usgs.gov/tiles/aerial_Imagery.cgi/$z/$x/$y&lt;/url&gt;
&lt;zoom min="2" max="15"/&gt;
&lt;bounds bottom="0" top="74"/&gt;
&lt;/map&gt;
</pre>
<p>The bounds are WGS84 latitude/longitude values in degrees. If omitted, the
default zoom range is &lt;0,&nbsp;19&gt; and the default bounds are
&lt;-85.0511,&nbsp;85.0511&gt; and &lt;-180,&nbsp;180&gt;.</p>
<p>Since version 5.17 GPXSee supports HiDPI map tiles. To specify that a map
uses HiDPI tiles use the <i>tilePixelRatio</i> tag. For the most common 512x512px
tiles (that shall be rendered as 256x256px tiles), set the value to 2.</p>
<h4 id="WMTS">WMTS</h4>
<p>WMTS maps are distinguished by setting the <i>type</i> attribute of the
<i>map</i> element to <code>WMTS</code>. Both the KVP and REST access methods
are supported.</p>
<p>For KVP, the <i>url</i> element represents the WMTS base URL and two
additional elements are required - <i>layer</i> and <i>set</i>
(TileMatrixSet in WMTS). Optional <i>format</i> and <i>style</i> elements may
be specified defining the desired image format and layer style. If not set,
<code>image/png</code> is used for <i>format</i> and the default style for
<i>style</i>.</p>
<pre>
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;map xmlns="http://www.gpxsee.org/map/1" type="WMTS"&gt;
&lt;name&gt;CUZK&lt;/name&gt;
&lt;url&gt;http://geoportal.cuzk.cz/WMTS_ZM_900913/WMTService.aspx&lt;/url&gt;
&lt;layer&gt;zm&lt;/layer&gt;
&lt;set axis="yx"&gt;ogc:1.0:globalcrs84pixel&lt;/set&gt;
&lt;/map&gt;
</pre>
<p>For REST access, the <i>url</i> element's <i>type</i> attribute must be set
to <code>REST</code>. The URL then represents the URL of the capabilities XML
document. Defining the format has no relevance for the REST access method.</p>
<pre>
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;map xmlns="http://www.gpxsee.org/map/1" type="WMTS"&gt;
&lt;name&gt;Wien - Ortho&lt;/name&gt;
&lt;url type="REST"&gt;http://maps1.wien.gv.at/wmts/1.0.0/WMTSCapabilities.xml&lt;/url&gt;
&lt;layer&gt;lb&lt;/layer&gt;
&lt;style&gt;farbe&lt;/style&gt;
&lt;set&gt;google3857&lt;/set&gt;
&lt;/map&gt;
</pre>
<p>There is one more important attribute - the <i>axis</i> attribute of the
<i>set</i> element. It specifies the axis order of the CRS used for the
tile matrix set. The default order is obtained from the CRS definition like
specified in the standard, but in praxis many servers use a wrong order. This
is why GPXSee enables overriding the default axis order using the <i>axis</i>
attribute. Possible values are <code>xy</code> and <code>yx</code>.</p>
<p>Finally, one can define additional dimensions like <code>Time</code> using
the <i>dimension</i> element. Use a separate entry for every additional dimension.</p>
<p>HiDPI WMTS tiles are supported too.</p>
<h4 id="WMS">WMS</h4>
<p>WMS maps are distinguished by setting the <i>type</i> attribute of the
<i>map</i> element to <code>WMS</code>. WMS map definitions are very similar to
WMTS map definitions, the main difference is that you must specify the map
CRS using the <i>crs</i> element instead of specifying the tile set. Like in the
case of the <i>set</i> element, you may specify the <i>axis</i> attribute to
override the default axis order.</p>
<p>It is possible to combine multiple WMS layers together in one map. To do so,
use a comma separated list of WMS layers as the <i>layer</i> element content and
a corresponding comma separated list as the <i>style</i> element content (can be
omitted if all styles are the default style).</p>
<pre>
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;map xmlns="http://www.gpxsee.org/map/1" type="WMS"&gt;
&lt;name&gt;Katastr nemovitostí&lt;/name&gt;
&lt;url&gt;http://services.cuzk.cz/wms/wms.asp&lt;/url&gt;
&lt;layer&gt;polygony_parcel,polygony_budov,polygony_k_u&lt;/layer&gt;
&lt;crs axis="yx"&gt;EPSG:3034&lt;/crs&gt;
&lt;/map&gt;
</pre>
<h3 id="offline">Offline maps</h3>
<p>OziExplorer maps, TrekBuddy maps/atlases, Garmin JNX maps and GeoTIFF images are
supported by GPXSee. Supported map projections are Mercator (including Web Mercator),
Transverse Mercator (including UTM), Lambert Conformal Conic, Albers Equal Area,
Lambert Azimuthal Equal Area, Křovák's and Latitude/Longitude (2D geographic).
Additionally, the Swiss and Hungarian Oblique Mercator projections are aupported using
LCC1 approximation. For list of supported datums and projected coordinate systems see
the <a href="https://github.com/tumic0/GPXSee/blob/master/pkg/csv/gcs.csv">GCS.csv</a>
and <a href="https://github.com/tumic0/GPXSee/blob/master/pkg/csv/pcs.csv">PCS.csv</a>
configuration files (can be modified or overridden by user files like the map
directory).</p>
<p>You may easily create offline atlases from online map services by using
<a href="http://mobac.sourceforge.net/">Mobile Atlas Creator (MOBAC)</a>.</p>
<h2 id="poi">POI files</h2>
<p>All of the supported formats with waypoints capability - GPX, KML, TCX, NMEA, WPT
and Garmin CSV - can be loaded either as data files or as POI files. When a file
is opened as a POI file, only waypoints reasonable near the tracks/waypoints of
the loaded data files are displayed.</p>
<p>To make GPXSee load a POI file automatically on startup, add the file to the
<code>POI</code> directory in one of the configuration paths.</p>
</div>
<div id="sidebar">
<h4><a href="#data">Data files</a></h4>
<h4><a href="#maps">Maps</a></h4>
<h5><a href="#online">Online maps</a></h5>
<h5><a href="#offline">Offline maps</a></h5>
<h4><a href="#poi">POI files</a></h4>
</div>
<div class="cl">&nbsp;</div>
</div>
</div>
</div>
<div class="footer">
<div class="shell">
<p class="lf">Copyright &copy; 2018 Martin Tůma - All Rights Reserved</p>
<p class="rf">Design by <a href="http://www.websitecsstemplates.com/" target="_blank">WebsiteCSSTemplates</a></p>
<div style="clear:both;"></div>
</div>
</div>
<!-- END PAGE SOURCE -->
</body>
</html>