vendor.rst 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. .. _wcs_vendor_parameters:
  2. WCS Vendor Parameters
  3. =====================
  4. WCS vendor parameters are non-standard request parameters
  5. that are defined by an implementation to provide enhanced capabilities.
  6. .. include:: ../generic_vendor_options.txt
  7. GetCoverage Request
  8. -------------------
  9. namespace
  10. ^^^^^^^^^
  11. Requests to the WCS GetCapabilities operation can be filtered to only return layers corresponding to a particular namespace.
  12. Sample code: ::
  13. http://example.com/geoserver/wcs?
  14. service=wcs&
  15. version=1.0.0&
  16. request=GetCapabilities&
  17. namespace=topp
  18. Using an invalid namespace prefix will not cause any errors, but the document returned will not contain information on any layers.
  19. cql_filter
  20. ^^^^^^^^^^
  21. The ``cql_filter`` parameter is similar to same named WMS parameter, and allows expressing a filter using ECQL (Extended Common Query Language).
  22. The filter is sent down into readers exposing a ``Filter`` read parameter.
  23. For example, assume a image mosaic has a tile index with a ``cloudCover`` percentage attribute, then it's possible to mosaic only
  24. granules with a cloud cover less than 10% using:
  25. cql_filter=cloudCover < 10
  26. For full details see the :ref:`filter_ecql_reference` and :ref:`cql_tutorial` tutorial.
  27. sortBy
  28. ^^^^^^
  29. The ``sortBy`` parameter allows to control the order of granules being mosaicked, using the same
  30. syntax as WFS 1.0, that is:
  31. * ``&sortBy=att1 A|D,att2 A|D, ...``
  32. This maps to a "SORTING" read parameter that the coverage reader might expose (image mosaic exposes such parameter).
  33. In image mosaic, this causes the first granule found in the sorting will display on top, and then the others will follow.
  34. Thus, to sort a scattered mosaic of satellite images so that the most recent image shows on top, and assuming the time attribute is called ``ingestion`` in the mosaic index, the specification will be ``&sortBy=ingestion D``.