~ubuntu-branches/debian/sid/gdal/sid

« back to all changes in this revision

Viewing changes to frmts/wms/frmt_wms.html

  • Committer: Package Import Robot
  • Author(s): Francesco Paolo Lovergine
  • Date: 2012-05-07 15:04:42 UTC
  • mfrom: (5.5.16 experimental)
  • Revision ID: package-import@ubuntu.com-20120507150442-2eks97loeh6rq005
Tags: 1.9.0-1
* Ready for sid, starting transition.
* All symfiles updated to latest builds.
* Added dh_numpy call in debian/rules to depend on numpy ABI.
* Policy bumped to 3.9.3, no changes required.

Show diffs side-by-side

added added

removed removed

Lines of Context:
30
30
                </tr>
31
31
                <tr>
32
32
                        <td class="xml">    &lt;Service name="<span class="value">WMS</span>"&gt;</td>
33
 
                        <td class="desc">Define what mini-driver to use, currently supported are: WMS, WorldWind, TileService, TMS. (required)</td>
 
33
                        <td class="desc">Define what mini-driver to use, currently supported are: WMS, WorldWind, TileService, TMS, TiledWMS or VirtualEarth. (required)</td>
34
34
                </tr>
35
35
                <tr>
36
36
                        <td class="xml">        &lt;Version&gt;<span class="value">1.1.1</span>&lt;/Version&gt;</td>
37
37
                        <td class="desc">WMS version. (optional, defaults to 1.1.1)</td>
38
38
                </tr>
39
39
                <tr>
40
 
                        <td class="xml">        &lt;ServerURL&gt;<span class="value">http://onearth.jpl.nasa.gov/wms.cgi?</span>&lt;/ServerUrl&gt;</td>
 
40
                        <td class="xml">        &lt;ServerUrl&gt;<span class="value">http://onearth.jpl.nasa.gov/wms.cgi?</span>&lt;/ServerUrl&gt;</td>
41
41
                        <td class="desc">WMS server URL. (required)</td>
42
42
                </tr>
43
43
                <tr>
58
58
        </tr>
59
59
                <tr>
60
60
                        <td class="xml">        &lt;Layers&gt;<span class="value">modis,global_mosaic</span>&lt;/Layers&gt;</td>
61
 
                        <td class="desc">Comma separated list of layers. (required)</td>
 
61
                        <td class="desc">Comma separated list of layers. (required, except for TiledWMS)</td>
62
62
                </tr>
 
63
        <tr>
 
64
            <td class="xml">        &lt;TiledGroupName&gt;<span class="value">Clementine</span>&lt;/TiledGroupName&gt;</td>
 
65
            <td class="desc">Comma separated list of layers. (required for TiledWMS)</td>
 
66
        </tr>
63
67
                <tr>
64
68
                        <td class="xml">        &lt;Styles&gt;&lt;/Styles&gt;</td>
65
69
                        <td class="desc">Comma separated list of styles. (optional)</td>
76
80
                </tr>
77
81
                <tr>
78
82
                        <td class="xml">    &lt;DataWindow&gt;</td>
79
 
                        <td class="desc">Define size and extents of the data. (required)</td>
 
83
                        <td class="desc">Define size and extents of the data. (required, except for TiledWMS and VirtualEarth)</td>
80
84
                </tr>
81
85
                <tr>
82
86
                        <td class="xml">        &lt;UpperLeftX&gt;<span class="value">-180.0</span>&lt;/UpperLeftX&gt;</td>
83
 
                        <td class="desc">X (longitude) coordinate of upper-left corner. (optional, defaults to -180.0)</td>
 
87
                        <td class="desc">X (longitude) coordinate of upper-left corner. (optional, defaults to -180.0, except for VirtualEarth)</td>
84
88
                </tr>
85
89
                <tr>
86
90
                        <td class="xml">        &lt;UpperLeftY&gt;<span class="value">90.0</span>&lt;/UpperLeftY&gt;</td>
87
 
                        <td class="desc">Y (latitude) coordinate of upper-left corner. (optional, defaults to 90.0)</td>
 
91
                        <td class="desc">Y (latitude) coordinate of upper-left corner. (optional, defaults to 90.0, except for VirtualEarth)</td>
88
92
                </tr>
89
93
                <tr>
90
94
                        <td class="xml">        &lt;LowerRightX&gt;<span class="value">180.0</span>&lt;/LowerRightX&gt;</td>
91
 
                        <td class="desc">X (longitude) coordinate of lower-right corner. (optional, defaults to 180.0)</td>
 
95
                        <td class="desc">X (longitude) coordinate of lower-right corner. (optional, defaults to 180.0, except for VirtualEarth)</td>
92
96
                </tr>
93
97
                <tr>
94
98
                        <td class="xml">        &lt;LowerRightY&gt;<span class="value">-90.0</span>&lt;/LowerRightY&gt;</td>
95
 
                        <td class="desc">Y (latitude) coordinate of lower-right corner. (optional, defaults to -90.0)</td>
 
99
                        <td class="desc">Y (latitude) coordinate of lower-right corner. (optional, defaults to -90.0, except for VirtualEarth)</td>
96
100
                </tr>
97
101
                <tr>
98
102
                        <td class="xml">        &lt;SizeX&gt;<span class="value">2666666</span>&lt;/SizeX&gt;</td>
140
144
                </tr>
141
145
                <tr>
142
146
                        <td class="xml">    &lt;BlockSizeX&gt;<span class="value">1024</span>&lt;/BlockSizeX&gt;</td>
143
 
                        <td class="desc">Block size in pixels. (optional, defaults to 1024)</td>
 
147
                        <td class="desc">Block size in pixels. (optional, defaults to 1024, except for VirtualEarth)</td>
144
148
                </tr>
145
149
                <tr>
146
150
                        <td class="xml">    &lt;BlockSizeY&gt;<span class="value">1024</span>&lt;/BlockSizeY&gt;</td>
147
 
                        <td class="desc">Block size in pixels. (optional, defaults to 1024)</td>
 
151
                        <td class="desc">Block size in pixels. (optional, defaults to 1024, except for VirtualEarth)</td>
148
152
                </tr>
149
153
                <tr>
150
154
                        <td class="xml">    &lt;OverviewCount&gt;<span class="value">10</span>&lt;/OverviewCount&gt;</td>
195
199
                        <td class="desc">Should requests, that otherwise would be partially outside of defined data window, be clipped resulting in smaller than block size request. (optional, defaults to true)</td>
196
200
                </tr>
197
201
                <tr>
 
202
                        <td class="xml">    &lt;UserAgent&gt;<span class="value">GDAL WMS driver (http://www.gdal.org/frmt_wms.html)</span>&lt;/UserAgent&gt;</td>
 
203
                        <td class="desc">HTTP User-agent string. Some servers might require a well-known user-agent such as "Mozilla/5.0" (optional, defaults to "GDAL WMS driver (http://www.gdal.org/frmt_wms.html)"). Added in GDAL 1.8.0</td>
 
204
                </tr>
 
205
        <tr>
 
206
            <td class="xml">    &lt;Referer&gt;<span class="value">http://example.foo/</span>&lt;/Referer&gt;</td>
 
207
            <td class="desc">HTTP Referer string. Some servers might require it (optional). Added in GDAL 1.9.0</td>
 
208
        </tr>
 
209
                <tr>
 
210
                        <td class="xml">    &lt;ZeroBlockHttpCodes&gt;<span class="value">204,404</span>&lt;/ZeroBlockHttpCodes&gt;</td>
 
211
                        <td class="desc">Comma separated list of HTTP response codes that will be interpreted as a 0 filled image (i.e. black for 3 bands, and transparent for 4 bands) instead of aborting the request. Added in GDAL 1.9.0. (optional, defaults to 204)</td>
 
212
                </tr>
 
213
                <tr>
 
214
                        <td class="xml">    &lt;ZeroBlockOnServerException&gt;<span class="value">true</span>&lt;/ZeroBlockOnServerException&gt;</td>
 
215
                        <td class="desc">Wether to treat a Service Exception returned by the server as a 0 filled image instead of aborting the request. Added in 1.9.0. (optional, defaults to false)</td>
 
216
                </tr>
 
217
                <tr>
198
218
                        <td class="xml">&lt;/GDAL_WMS&gt;</td>
199
219
                        <td class="desc"></td>
200
220
                </tr>
267
287
  Two examples of usage of the TMS service are included in the examples below.
268
288
</p>  
269
289
 
 
290
<h3>OnEarth Tiled WMS (GDAL 1.9.0 and later)</h3>
 
291
<p>
 
292
The OnEarth Tiled WMS minidriver supports the Tiled WMS specification
 
293
implemented for the JPL OnEarth driver per the specification at
 
294
<a href="http://onearth.jpl.nasa.gov/tiled.html">http://onearth.jpl.nasa.gov/tiled.html</a>.<p>
 
295
 
 
296
A typical OnEarth Tiled WMS configuration file might look like:
 
297
 
 
298
<pre>
 
299
&lt;GDAL_WMS&gt;
 
300
    &lt;Service name="TiledWMS"&gt;
 
301
        &lt;ServerUrl&gt;http://onmoon.jpl.nasa.gov/wms.cgi?&lt;/ServerUrl&gt;
 
302
        &lt;TiledGroupName&gt;Clementine&lt;/TiledGroupName&gt;
 
303
    &lt;/Service&gt;
 
304
&lt;/GDAL_WMS&gt;
 
305
</pre>
 
306
 
 
307
Most of the other information is automatically fetched from the remote
 
308
server using the GetTileService method at open time. <p>
 
309
 
 
310
<h3>VirtualEarth (GDAL 1.9.0 and later)</h3>
 
311
<p>
 
312
Access to web-based Virtual Earth tile services. Access is always tile based.<p>
 
313
<p>The ${quadkey} variable must be found in the ServerUrl element.<p>
 
314
<p>The DataWindow element might be omitted. The default values are :
 
315
<ul>
 
316
<li>UpperLeftX = -20037508.34</li>
 
317
<li>UpperLeftY = 20037508.34</li>
 
318
<li>LowerRightX = 20037508.34</li>
 
319
<li>LowerRightY = -20037508.34</li>
 
320
<li>TileLevel = 19</li>
 
321
<li>OverviewCount = 18</li>
 
322
<li>SRS = EPSG:900913</li>
 
323
<li>BlockSizeX = 256</li>
 
324
<li>BlockSizeY = 256</li>
 
325
</ul>
 
326
</p> 
 
327
 
270
328
<h2>Examples</h2>
271
329
 
272
330
<ul>
273
 
    <li>
 
331
    <li><p>
274
332
        <a href="frmt_wms_onearth_global_mosaic.xml">onearth_global_mosaic.xml</a> - Landsat mosaic from a <a href="http://onearth.jpl.nasa.gov/">OnEarth</a> WMS server<br>
275
333
        <pre>gdal_translate -of JPEG -outsize 500 250 onearth_global_mosaic.xml onearth_global_mosaic.jpg</pre>
276
334
        <img src="http://sydney.freeearthfoundation.com/gdalwms/onearth_global_mosaic.jpg" alt="example output">
277
335
        <pre>gdal_translate -of JPEG -projwin -10 55 30 35 -outsize 500 250 onearth_global_mosaic.xml onearth_global_mosaic2.jpg</pre>
278
336
        <img src="http://sydney.freeearthfoundation.com/gdalwms/onearth_global_mosaic2.jpg" alt="example output">
279
 
    </li>
280
 
    <li>
 
337
    </p></li>
 
338
 
 
339
    <li><p>
281
340
        <a href="frmt_wms_metacarta_wmsc.xml">metacarta_wmsc.xml</a> - 
282
341
        It is possible to configure a WMS Service conforming to a WMS-C cache by
283
342
        specifying a number of overviews and specifying the 'block size' as the 
285
344
        a 19-level "Global Profile" WMS-C cache.
286
345
        <pre>gdal_translate -of PNG -outsize 500 250 metacarta_wmsc.xml metacarta_wmsc.png</pre>
287
346
        <img src="http://sydney.freeearthfoundation.com/gdalwms/metacarta_wmsc.png" alt="example output">
288
 
    </li>
289
 
    <li>
 
347
    </p></li>
 
348
 
 
349
    <li><p>
290
350
        <a href="frmt_wms_tileservice_bmng.xml">tileservice_bmng.xml</a> - TileService, Blue Marble NG (January)<br>
291
351
        <pre>gdal_translate -of JPEG -outsize 500 250 tileservice_bmng.xml tileservice_bmng.jpg</pre>
292
352
        <img src="http://sydney.freeearthfoundation.com/gdalwms/tileservice_bmng.jpg" alt="example output">
293
 
    </li>
294
 
    <li>
 
353
    </p></li>
 
354
 
 
355
    <li><p>
295
356
        <a href="frmt_wms_tileservice_nysdop2004.xml">tileservice_nysdop2004.xml</a> - TileService, NYSDOP 2004<br>
296
357
        <pre>gdal_translate -of JPEG -projwin -73.687030 41.262680 -73.686359 41.262345 -outsize 500 250 tileservice_nysdop2004.xml tileservice_nysdop2004.jpg</pre>
297
358
        <img src="http://sydney.freeearthfoundation.com/gdalwms/tileservice_nysdop2004.jpg" alt="example output">
298
 
    </li>
299
 
    <li>
 
359
    </p></li>
 
360
 
 
361
    <li><p>
300
362
     <a href="frmt_wms_openstreetmap_tms.xml">OpenStreetMap TMS Service Example</a>: Connect to OpenStreetMap tile service. Note that this file takes advantage of the tile cache; more information about configuring the tile cache settings is available above.<br />
301
363
     <tt>gdal_translate -of PNG -outsize 512 512 frmt_wms_openstreetmap_tms.xml openstreetmap.png</tt>
302
 
    </li>
 
364
    </p></li>
303
365
 
304
 
    <li>
 
366
    <li><p>
305
367
     <a href="frmt_wms_metacarta_tms.xml">MetaCarta TMS Layer Example</a>, accessing the default MetaCarta TMS layer.<br />
306
368
          <tt>gdal_translate -of PNG -outsize 512 256 frmt_wms_metacarta_tms.xml metacarta.png</tt>
307
 
    </li>
308
 
</ul>
309
 
 
310
 
<p>See Also:</p>
 
369
    </p></li>
 
370
 
 
371
    <li><p>
 
372
     <a href="frmt_wms_bluemarble_s3_tms.xml">BlueMarble Amazon S3 Example</a> accessed with the TMS minidriver.
 
373
    </p></li>
 
374
 
 
375
    <li><p>
 
376
     <a href="frmt_wms_googlemaps_tms.xml">Google Maps</a> accessed with the TMS minidriver.
 
377
    </p></li>
 
378
 
 
379
    <li><p>
 
380
     <a href="frmt_wms_arcgis_mapserver_tms.xml">ArcGIS MapServer Tiles</a> accessed with the TMS minidriver.
 
381
    </p></li>
 
382
 
 
383
    <li><p>
 
384
     <a href="frmt_wms_swissgeo_tms.xml">Swiss Geoportal maps</a> accessed with the TMS minidriver (needs GDAL >= 1.9.0)
 
385
    </p></li>
 
386
 
 
387
    <li><p>
 
388
     OnEarth Tiled WMS <a href="frmt_twms_Clementine.xml">Clementine</a>,
 
389
     <a href="frmt_twms_daily.xml">daily</a>, and
 
390
     <a href="frmt_twms_srtm.xml">srtm</a> examples.<p>
 
391
    </p></li>
 
392
 
 
393
    <li><p>
 
394
     <a href="frmt_wms_virtualearth.xml">VirtualEarth Aerial Layer</a> accessed with the VirtualEarth minidriver.
 
395
    </p></li>
 
396
</ul>
 
397
 
 
398
<h2>Open syntax</h2>
 
399
 
 
400
The WMS driver can open :
 
401
<ul>
 
402
<li><p>
 
403
a local service description XML file : <pre>gdalinfo description_file.xml</pre>
 
404
</p></li>
 
405
 
 
406
<li><p>
 
407
the content of a description XML file provided as filename :
 
408
<pre>gdalinfo "&lt;GDAL_WMS&gt;&lt;Service name=\"TiledWMS\"&gt;&lt;ServerUrl&gt;http://onearth.jpl.nasa.gov/wms.cgi?&lt;/ServerUrl&gt;&lt;TiledGroupName&gt;Global SRTM Elevation&lt;/TiledGroupName&gt;&lt;/Service&gt;&lt;/GDAL_WMS&gt;"</pre>
 
409
</p></li>
 
410
 
 
411
<li><p>
 
412
(GDAL >= 1.9.0) the base URL of a WMS service, prefixed with <i>WMS:</i> :
 
413
<pre>gdalinfo "WMS:http://wms.geobase.ca/wms-bin/cubeserv.cgi"</pre><p>
 
414
A list of subdatasets will be returned, resulting from the parsing of the GetCapabilities request on that server.
 
415
</p></li>
 
416
 
 
417
<li><p>
 
418
(GDAL >= 1.9.0) a pseudo GetMap request, such as the subdataset name returned by the previous syntax :
 
419
<pre>gdalinfo "WMS:http://wms.geobase.ca/wms-bin/cubeserv.cgi?SERVICE=WMS&amp;VERSION=1.1.1&amp;REQUEST=GetMap&amp;LAYERS=DNEC_250K:ELEVATION/ELEVATION&amp;SRS=EPSG:42304&amp;BBOX=-3000000,-1500000,6000000,4500000"</pre>
 
420
</p></li>
 
421
 
 
422
<li><p>
 
423
(GDAL >= 1.9.0) the base URL of a Tiled WMS service, prefixed with <i>WMS:</i> and with request=GetTileService as GET argument:
 
424
<pre>gdalinfo "WMS:http://onearth.jpl.nasa.gov/wms.cgi?request=GetTileService"</pre><p>
 
425
A list of subdatasets will be returned, resulting from the parsing of the GetTileService request on that server.
 
426
</p></li>
 
427
 
 
428
<li><p>
 
429
(GDAL >= 1.9.0) the URL of a REST definition for a ArcGIS MapServer:
 
430
<pre>gdalinfo "http://server.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer?f=json&amp;pretty=true"</pre><p>
 
431
</p></li>
 
432
</ul>
 
433
 
 
434
<h2>See Also:</h2>
311
435
 
312
436
<ul>
313
437
<li><a href="http://www.opengeospatial.org/standards/wms">OGC WMS Standards</a></li>
314
 
<li><a href="http://wiki.osgeo.org/index.php/WMS_Tiling_Client_Recommendation">WMS Tiling Client Recommendation</a></li>
315
 
<li><a href="http://www.worldwindcentral.com/wiki/TileService">TileService</a></li>
 
438
<li><a href="http://wiki.osgeo.org/index.php/WMS_Tiling_Client_Recommendation">WMS Tiling Client Recommendation (WMS-C)</a></li>
 
439
<li><a href="http://www.worldwindcentral.com/wiki/TileService">WorldWind TileService</a></li>
 
440
<li><a href="http://wiki.osgeo.org/wiki/Tile_Map_Service_Specification">TMS Specification</a></li>
 
441
<li><a href="http://onearth.jpl.nasa.gov/tiled.html">OnEarth Tiled WMS specification</a></li>
316
442
</ul>
317
443
 
318
444
</body>