EOX GitLab Instance

Skip to content
Snippets Groups Projects
Verified Commit ec65358b authored by Stephan's avatar Stephan
Browse files

Partly review of web client and searching.

parent 7b92e2fe
No related branches found
No related tags found
1 merge request!8Docs
Hide whitespace changes
Inline Side-by-side
documentation/usage-guide/searching.md → documentation/usage-guide/searching.rst
+ 89
− 0
View file @ ec65358b
# Searching
Searching
=========
The main searching interface is supported using OpenSearch using
various extension.
The main interface for searching is provided by OpenSearch using various
extensions.
TODO add links to spec
The OpenSearch URL endpoints are:
* `/opensearch`: Main service description
* `/opensearch/<format>`: Search for collections in a specific format
* `/opensearch/collections/<collection-id>`: Collection specific description
* `/opensearch/collections/<collection-id>/<format>`: Search for products in a collection in that format
* `/opensearch/collections/<collection-id>/<format>`: Search for products in
a collection in that format
The description related entrypoints provide an OpenSearch Description
Document (OSDD). This XML based file format describes general service metadata and various access URLs.
The description related entrypoints provide an OpenSearch Description Document
(OSDD). This XML based file format describes general service metadata and
various access URLs.
These URL objects provide templates that can be filled with
parameters to submit actual metadata queries. Depending on the used
......@@ -45,31 +49,41 @@ to pass parameters that control the query and shape of the search.
The following table shows all parameters available for both collection
and product search:
| Parameter | Description |
| ------------- | --------------------------------------------------------------------------------------------- |
| startIndex | The index offset of the items. Used to get subsets of a result set |
| count | The number of records for each page |
| start | The start timestamp for the time range |
| end | The end timestamp for the time range |
| timerel | The semantic of the time range. Either `intersects`, `contains`, `disjoint`, or `equals` |
| bbox | The geographic bounding box expressed as `min-lon`, `min-lat`, `max-lon`, `max-lat` in WGS 84 |
| geom | A WKT encoded geometry for a geographic search |
| lon | The longitude component of point/radius searches |
| lat | The latitude component of point/radius searches |
| r | The radious in metres of point/radius searches |
| georel | The semantic of the geometry filter. One of `intersects`, `contains`, or `disjoint` |
The following parameters are only available in collection searchesin
addition the general search parameters:
| Parameter | Description |
| ------------- | --------------------------------------------------------------------------------------------- |
============= =================================================================
Parameter Description
============= =================================================================
startIndex | The index offset of the items. Used to get subsets of a result
set
count | The number of records for each page
start | The start timestamp for the time range
end | The end timestamp for the time range
timerel | The semantic of the time range. Either `intersects`,
`contains`, `disjoint`, or `equals`
bbox | The geographic bounding box expressed as `min-lon`, `min-lat`,
`max-lon`, `max-lat` in WGS 84
geom | A WKT encoded geometry for a geographic search
lon | The longitude component of point/radius searches
lat | The latitude component of point/radius searches
r | The radious in metres of point/radius searches
georel | The semantic of the geometry filter. One of `intersects`,
`contains`, or `disjoint`
============= =================================================================
The following parameters are only available in collection searches in
addition to the general search parameters:
============= =================================================================
Parameter Description
============= =================================================================
============= =================================================================
The following parameters are only available in product searches in
addition the general search parameters:
| Parameter | Description |
| ------------- | --------------------------------------------------------------------------------------------- |
| cloudCover | Cloud cover filter. Either a specific value or an interval of values. Values between 0-100 |
addition to the general search parameters:
============= =================================================================
Parameter | Description
============= =================================================================
cloudCover | Cloud cover filter. Either a specific value or an interval of
values. Values between 0-100
============= =================================================================
documentation/usage-guide/viewing.md deleted 100644 → 0
+ 0
− 1
View file @ 7b92e2fe
# Viewing
documentation/usage-guide/viewing.rst 0 → 100644
+ 4
− 0
View file @ ec65358b
Viewing
=======
documentation/usage-guide/web-client.rst
+ 101
− 29
View file @ ec65358b
......@@ -2,14 +2,20 @@ Web Client
==========
The most comfortable way to exploit the functionalities of the View Server (VS)
is via the built-in `web client <https://github.com/eoxc/prism>`_ based on `eoxc <https://github.com/eoxc/eoxc>`_ library. This client provides an intuitively to use
interactive graphical user interface running in the user's web browser.
When the web client is opened for the first time a short interactive tutorial starts. It should guide you through some of main features and elements. You can start this intro again clicking the *book* icon in the bottom right of the window.
is via the built-in `web client <https://github.com/eoxc/prism>`_. This client
is based on the open source `eoxc <https://github.com/eoxc/eoxc>`_ library and
provides an intuitively to use interactive graphical user interface running in
the user's web browser.
Interactive Tutorial
--------------------
When the web client is opened for the first time a short interactive tutorial
starts as shown in :numref:`fig_webclient_tutorial` below. It guides the user
through the main features and elements. The tutorial can be started again
anytime by clicking the *book* icon in the bottom right of the window.
.. _fig_webclient_tutorial:
.. figure:: images/webclient_tutorial_01_start.*
:alt: Web Client Tutorial - Start
......@@ -17,49 +23,109 @@ Interactive Tutorial
Map
---
The main map view is for visualization and browsing through ingested satellite image data catalog. Navigate to your area of interest by:
* *panning*: using left click + drag or one finger drag and two finger pinch
* *zooming*: using mouse wheel scroll, double click or plus and minus icons in bottom right corner of a map
The main map view is for visualization and interactively browsing through
available satellite data. Navigating to the area of interest is done by:
While hovering over footprints on the map, the respective product(s) are highlighted in the map, Timeslider and the Search Results menu. Same behavior is applied vice versa while hovering over dot groups in Timeslider and individual items in Search Results.
* *panning*: left click + drag or one finger drag and
* *zooming*: mouse wheel scroll, double click, two finger pinch, or the plus
and minus icons in the bottom right corner of the map.
Clicking on the footprints in the map and then clicking on the *plus* or *minus* button overlays can used to add or remove images to/from selection for the download (see Download below).
.. figure:: images/webclient_tutorial_02_map.*
:alt: Web Client Tutorial - Map
In the top most part of the map, there is a colored bar loading indicator spanning full width of the web client, making it easier to see if loading of all requested map tiles is already finished or still in progress.
*Web Client Tutorial - Map*
You can see current cursor geographical coordinates as longitude, latitude pair in the bottom left corner of the map. Web client by default uses a coordinate reference system EPSG:4326.
While hovering over footprints on the map, the respective product(s) are
highlighted in the *map*, *timeslider*, and the *Search Results* menu. The same
behavior is applied vice versa while hovering over dot groups in the
*timeslider* and individual items in the *Search Results*.
There are two side panels: left menu for layer selection and applying filters and right menu for listing available products and downloading them.
.. figure:: images/webclient_highlighting.*
:alt: Web Client - 3-way highlighting
You can also see current layer without any extra UI elements by clicking on the *landscape map* icon in the bottom right of the map window. It opens a list of available layers. Clicking on one opens a new browser tab with a created *WMS* request copying current map parameters (zoom, bounding box, selected time, styling etc).
*Web Client - 3-way highlighting*
.. figure:: images/webclient_tutorial_02_map.*
:alt: Web Client Tutorial - Map
Clicking on a footprint in the map followed by clicking on the *plus* or *minus*
button can be used to add or remove a product to or from the *basket*, holding
the list of products selected for download (see :ref:`weblient_download`
below).
*Web Client Tutorial - Map*
.. figure:: images/webclient_select-on-map.*
:alt: Web Client - Select on map
*Web Client - Select on map*
In the top most part of the map, there is a colored bar spanning the full width
of the web client acting as loading indicator. It makes it easier to see if the
loading of all requested map tiles is already finished or still in progress.
.. figure:: images/webclient_loading-indicator.*
:alt: Web Client - Loading indicator
*Web Client - Loading indicator*
The geographic coordinates of the current cursor location can be seen as
longitude, latitude pair in the bottom left corner of the map.
.. figure:: images/webclient_coordinates.*
:alt: Web Client - Coordinates
*Web Client - Coordinates*
Clicking on the *landscape map* icon in the bottom right of the map window shows
a list of available layers. Clicking on one of the layers opens a new browser
tab showing this layer as currently visible on the map by generating a *WMS*
request copying the current map parameters (zoom, bounding box, selected time,
styling, etc.).
.. figure:: images/webclient_current-view.*
:alt: Web Client - Current view
*Web Client - Current view*
Timeslider
----------
Timeslider presents the distribution of datasets in time via *bar* graph or *aggregated dots* graph. Visualization mode used (*bars* or *dots*) is based on current total number of products for given time frame. You can use Timeslider tool in following ways:
* panning: on the bottom area (left click + drag) or left and right arrow icons on sides
* zooming: mouse wheel scroll or two finger pinch or plus and minus icons in the middle
* reloading: click on spinner icon in the middle
* selecting a time interval: in the upper area left click + drag or one finger drag or click on histogram bucket
* showing total number of available products in histogram bucket: hover over histogram bucket
* showing footprints of all products, first product id and total number of additional products in a dot group: hover over a dot group
* showing start and end of current selection: left click + hold on selection rectangle
* zooming a map to a combined minimum bounding box of all products in a dot group: click on dot group
The *timeslider* presents the distribution of products in time via a *bar* (see
:numref:`fig_webclient_timeslider`) or an *aggregated dots* (see
:numref:`fig_webclient_timeslider_dots`) graph. The visualization mode used
(*bars* or *dots*) is based on the total number of products available for the
shown time duration.
.. _fig_webclient_timeslider:
.. figure:: images/webclient_tutorial_03_timeslider.*
:alt: Web Client Tutorial - Timeslider
*Web Client Tutorial - Timeslider*
.. _fig_webclient_timeslider_dots:
.. figure:: images/webclient_timeslider-dots.*
:alt: Web Client - Timeslider dots
*Web Client - Timeslider dots*
The interactive *timeslider* can be used in the following ways:
* *panning*: left click + drag or one finger drag on the bottom area (below the
horizontal line) or left and right arrow icons on the sides
* *zooming*: mouse wheel scroll, two finger pinch, or plus and minus icons in
the middle
* *reloading*: spinner icon in the middle
* *selecting a time interval*: left click + drag or one finger drag in the upper
area (above the horizontal line) or click on a histogram bucket
* *showing the total number of available products in a histogram bucket*: hover
over the histogram bucket
* *showing the footprints of all products, the first product id, and the total
number of additional products in a dot group*: hover over the dot group
* *showing start and end of the current selection*: left click + hold on
selection rectangle
* *zooming the map to a combined minimum bounding box of all products in a dot
group*: click on the dot group
Search Results
--------------
Right part of the map window contains a panel with *Search Results* for each enabled layer based on current area, time and additional filters. Items in the panel are sorted based on order in which the catalog returns them (by default from the oldest to the newest).
Search can be enabled and disabled for each displayed layer individually by clicking on the large button *X layers selected to show n/n* and clicking on corresponding layer entry or by clicking on the *Search* toggle if only Single Layer is configured.
......@@ -81,6 +147,7 @@ Items selected for download can be viewed in the *Basket* tab or *Selected* butt
Filters
-------
There are several possibilities to filter queried satellite data in the *Filters* panel on left side of the window:
1. Spatial query: with Spatial Filter using the Point, Rectangle or Polygon drawing options under *Draw*. By default when no spatial filter is set, current map window extent is used as a spatial filter.
......@@ -96,6 +163,7 @@ There are several possibilities to filter queried satellite data in the *Filters
Map Layers
----------
*Layers* panel on left side enables setting the *Overlay*, *Layer* and *Base Layer* groups currently visualized.
*Base Layer* and *Overlay* groups enable choosing the background, text labels and other footprints to be viewed on the map window for easier orientation.
......@@ -115,7 +183,8 @@ Changing the visualization (styling) of layers can be done by clicking on the *p
Details Display
---------------
In order to view details display panel for a single selected product, either click on the *info* (i) icon after clicking on the product footprint on the map or product entry in Search Results panel.
In order to view details display panel for a single selected product, either click on the *info* (i) icon after clicking on the product footprint on the map or product entry in Search Results panel.
Newly opened overlay displays a map window with a set visualization and linked metadata. It also contains links to several product related OGC compliant services requests (WMS, WCS etc). More information can be found in *sample-requests* usage-guide chapter.
......@@ -128,15 +197,18 @@ Product can be added to selection for download by enabling the respective checkb
*Web Client Details Display*
.. _weblient_download:
Download
--------
Several methods of downloading products or only parts of them are made possible by the web client.
Several methods of downloading products or only parts of them are made possible by the web client.
After selecting one or more products for download, you can view a full list of them on the right panel, either on *Search Results* tab via *Selected* button if only one layer is pre-configured or on *Basket* tab if more layers were configured for display.
In order to download a full product (image and linked metadata file) or a full coverage (just the image), view Details Display of that product using the *info* icon and click on a respective *Download Package* or *WCS: GetCoverage* links on the left side of newly shown overlay. These lead to default *Get Product* or *Get Coverage* WCS requests for that specific product and shall start respective downloads.
In order to download more than one product in parallel, after selecting several products for download, you can click on *Download* or *Download as* buttons on the right panel of the web client.
In order to download more than one product in parallel, after selecting several products for download, you can click on *Download* or *Download as* buttons on the right panel of the web client.
- *Download as* currently offers a *Download as URL-List* option which downloads a *.txt* file with a list of download links (*Get Coverage* requests) and *Download as Metalink* allowing for possibly increased speed via segment downloading by metalink-aware software.
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment