Find filtering parameter for a data collection


#1

When you query a data collection (index or series), you can apply parameter to your request.

With opensearch-client

opensearch-client -p start=2016-01-01T12:00:00 -p stop=2016-01-02:T12:00:00 https://catalog.terradue.com/sentinel1/search identifier

Same with curl

curl "https://catalog.terradue.com/sentinel1/search?start=2016-01-01T12:00:00&stop=2016-01-02:T12:00:00"

What are the others filtering parameters and their format for this collection. The simplest way for finding out is to take the search endpoint in a web browser. For instance:

https://catalog.terradue.com/sentinel1/search

and to replace the operation part of the url /search with /description. It becomes:

https://catalog.terradue.com/sentinel1/description

If you query it via curl or in a web browser, you should see:

<?xml version="1.0" encoding="utf-8"?> <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:dct="http://purl.org/dc/terms/" xmlns:eop="http://www.opengis.net/eop/2.0" xmlns:geo="http://a9.com/-/opensearch/extensions/geo/1.0/" xmlns:param="http://a9.com/-/spec/opensearch/extensions/parameters/1.0/" xmlns:t2="http://www.terradue.com/opensearch" xmlns:time="http://a9.com/-/opensearch/extensions/time/1.0/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ShortName>All Entries</ShortName> <Description>This Service searches for all entries in the index sentinel1. There are several URL templates that return the results in different formats.This search service is in accordance with the OGC 10-032r3 specification.</Description> <Contact>info@terradue.com</Contact> <Url indexOffset="1" pageOffset="1" rel="results" template="https://catalog.terradue.com:443//sentinel1/search?format=atomeop&amp;count={count?}&amp;startPage={startPage?}&amp;startIndex={startIndex?}&amp;q={searchTerms?}&amp;lang={language?}&amp;update={dct:modified?}&amp;do={t2:downloadOrigin?}&amp;start={time:start?}&amp;stop={time:end?}&amp;trel={time:relation?}&amp;bbox={geo:box?}&amp;uid={geo:uid?}&amp;geom={geo:geometry?}&amp;rel={geo:relation?}&amp;pt={eop:productType?}&amp;psn={eop:platform?}&amp;psi={eop:platformSerialIdentifier?}&amp;isn={eop:instrument?}&amp;st={eop:sensorType?}&amp;pl={eop:processingLevel?}&amp;ot={eop:orbitType?}&amp;title={eop:title?}&amp;kw={eop:keyword?}&amp;pi={eop:parentIdentifier?}&amp;od={eop:orbitDirection?}&amp;track={eop:track?}&amp;frame={eop:frame?}&amp;swath={eop:swathIdentifier?}&amp;cc={eop:cloudCover?}&amp;lc={t2:landCover?}" type="application/atom+xml; profile=http://earth.esa.int/eop/2.1"> <param:Parameter maxInclusive="200" minimum="0" name="count" title="number of search results per page desired" value="{count?}"/> <param:Parameter minimum="0" name="startPage" title="page number of the set of search results desired" value="{startPage?}"/> <param:Parameter minimum="0" name="startIndex" title="index of the first search result desired" value="{startIndex?}"/> <param:Parameter minimum="0" name="q" title="EO Free Text Search" value="{searchTerms?}"> <atom:link atom:href="https://catalog.terradue.com//doc/query/freetextsearch.html" atom:rel="profile" atom:title="EO Free Text Search Reference" xmlns:atom="http://www.w3.org/2005/Atom"/> </param:Parameter> <param:Parameter minimum="0" name="lang" title="desired language of the results" value="{language?}"/> <param:Parameter minimum="0" name="update" title="date after which dataset are updated (RFC-3339)" value="{dct:modified?}"/> <param:Parameter minimum="0" name="do" title="a string that identifies the download origin (keyword, hostname...) to adapt the enclosure. If the parameter is enclosed between [] (e.g. [terradue]), enclosure will be returned only if there is a enclosure found for this source." value="{t2:downloadOrigin?}"/> <param:Parameter maxInclusive="2017-02-17T12:29:14.7360000Z" minInclusive="2014-06-15T03:44:43.9240000Z" minimum="0" name="start" title="start of the temporal interval (RFC-3339)" value="{time:start?}"/> <param:Parameter maxInclusive="2017-02-17T12:29:14.7360000Z" minInclusive="2014-06-15T03:44:43.9240000Z" minimum="0" name="stop" title="stop of the temporal interval (RFC-3339)" value="{time:end?}"/> <param:Parameter minimum="0" name="bbox" title="Rectangular bounding box" value="{geo:box?}"/> <param:Parameter minimum="0" name="geom" title="Geometry in WKT" value="{geo:geometry?}"/> <param:Parameter minimum="0" name="uid" title="The identifier of the resource within the search engine context (local reference)" value="{geo:uid?}"/> <param:Parameter minimum="0" name="rel" title="Spatial relation (possible values are “intersects”, “contains”, “disjoint”). The default is intersects." value="{geo:relation?}"> <param:Option label="Intersects" value="intersects"/> <param:Option label="Contains" value="contains"/> <param:Option label="Disjoint" value="disjoint"/> </param:Parameter> <param:Parameter minimum="0" name="trel" title="Temporal relation (possible values are “intersects”, “contains”, “during”, “disjoint”, “equals”)" value="{time:relation?}"> <param:Option label="Intersects" value="intersects"/> <param:Option label="Contains" value="contains"/> <param:Option label="Disjoint" value="disjoint"/> <param:Option label="During" value="during"/> <param:Option label="Equals" value="equals"/> </param:Parameter> <param:Parameter minimum="0" name="pt" title="A string identifying the product type" value="{eop:productType?}"> <param:Option label="GRD" value="GRD"/> <param:Option label="RAW" value="RAW"/> <param:Option label="SLC" value="SLC"/> <param:Option label="OCN" value="OCN"/> </param:Parameter> <param:Parameter minimum="0" name="psn" title="A string with the platform short name" value="{eop:platform?}"> <param:Option label="S1A" value="S1A"/> <param:Option label="S1B" value="S1B"/> </param:Parameter> <param:Parameter minimum="0" name="psi" title="A string with the Platform serial identifier" value="{eop:platformSerialIdentifier?}"> <param:Option label="0000-000A" value="0000-000A"/> <param:Option label="2014-016A" value="2014-016A"/> <param:Option label="2016-025A" value="2016-025A"/> </param:Parameter> <param:Parameter minimum="0" name="isn" title="A string identifying the instrument" value="{eop:instrument?}"> <param:Option label="SAR" value="SAR"/> </param:Parameter> <param:Parameter minimum="0" name="st" title="A string identifying the sensor type" value="{eop:sensorType?}"> <param:Option label="RADAR" value="RADAR"/> </param:Parameter> <param:Parameter minimum="0" name="pl" title="A string identifying the processing level applied to the dataset" value="{eop:processingLevel?}"> <param:Option label="L1" value="L1"/> <param:Option label="L0" value="L0"/> <param:Option label="L2" value="L2"/> </param:Parameter> <param:Parameter minimum="0" name="od" title="A string identifying the orbit direction" value="{eop:orbitDirection?}"> <param:Option label="ASCENDING" value="ASCENDING"/> <param:Option label="DESCENDING" value="DESCENDING"/> </param:Parameter> <param:Parameter minimum="0" name="ot" title="A string identifying the orbit type" value="{eop:orbitType?}"> <param:Option label="LEO" value="LEO"/> </param:Parameter> <param:Parameter minimum="0" name="title" title="A name given to the resource" value="{eop:title?}"/> <param:Parameter minimum="0" name="kw" title="Commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject" value="{eop:keyword?}"/> <param:Parameter minimum="0" name="pi" title="A string identifying the collection of the entry in a hierarchy of dataset" value="{eop:parentIdentifier?}"> <param:Option label="IW_GRDH_1SDV" value="IW_GRDH_1SDV"/> <param:Option label="IW_SLC__1SDV" value="IW_SLC__1SDV"/> <param:Option label="IW_RAW__0SDV" value="IW_RAW__0SDV"/> <param:Option label="IW_GRDH_1SSV" value="IW_GRDH_1SSV"/> <param:Option label="IW_SLC__1SSV" value="IW_SLC__1SSV"/> <param:Option label="IW_RAW__0SSV" value="IW_RAW__0SSV"/> <param:Option label="EW_GRDM_1SDH" value="EW_GRDM_1SDH"/> <param:Option label="EW_RAW__0SDH" value="EW_RAW__0SDH"/> <param:Option label="EW_GRDM_1SSH" value="EW_GRDM_1SSH"/> <param:Option label="EW_RAW__0SSH" value="EW_RAW__0SSH"/> </param:Parameter> <param:Parameter minimum="0" name="track" title="A number, set or interval requesting the range of orbit tracks " value="{eop:track?}"/> <param:Parameter minimum="0" name="frame" title="A number, set or interval requesting the range of orbit frames" value="{eop:frame?}"/> <param:Parameter minimum="0" name="swath" title="Swath identifier that corresponds to precise incidence angles for the sensor" value="{eop:swathIdentifier?}"> <param:Option label="IW" value="IW"/> <param:Option label="IW1 IW2 IW3" value="IW1 IW2 IW3"/> <param:Option label="EW" value="EW"/> <param:Option label="IW1IW2IW3" value="IW1IW2IW3"/> <param:Option label="WV1WV2" value="WV1WV2"/> <param:Option label="WV1 WV2" value="WV1 WV2"/> <param:Option label="S6" value="S6"/> <param:Option label="S3" value="S3"/> <param:Option label="S4" value="S4"/> <param:Option label="S1" value="S1"/> </param:Parameter> <param:Parameter minimum="0" name="lc" title="A number, set or interval requesting the land coverage" value="{t2:landCover?}"/> <param:Parameter minimum="0" name="cc" title="A number, set or interval requesting the cloud coverage" value="{eop:cloudCover?}"/> </Url> ... <Url indexOffset="1" pageOffset="1" rel="self" template="https://catalog.terradue.com:443//sentinel1/description" type="application/opensearchdescription+xml"/> <Developer>Terradue Cloud Platform Development Team</Developer> <Attribution>Terradue</Attribution> <SyndicationRight>open</SyndicationRight> <AdultContent>false</AdultContent> <Language>en-us</Language> <OutputEncoding>UTF-8</OutputEncoding> <InputEncoding>UTF-8</InputEncoding> </OpenSearchDescription>

Take the first <Url> element, you will find <param:Parameter> elements, each of them corresponding to an applicable filter for the query.

For instance:

<param:Parameter minimum="0" name="pt" title="A string identifying the product type" value="{eop:productType?}"> <param:Option label="GRD" value="GRD"/> <param:Option label="RAW" value="RAW"/> <param:Option label="SLC" value="SLC"/> <param:Option label="OCN" value="OCN"/> </param:Parameter>

means that a filter called pt (product type) can be applied to the query with the possible value of GRD, RAW, SLC or OCN.

Practically, with opensearch-client:

opensearch-client -p pt=SLC https://catalog.terradue.com/sentinel1/search identifier

will return the Single Look Complex products.

Another one:

<param:Parameter minimum="0" name="lc" title="A number, set or interval requesting the land coverage" value="{t2:landCover?}"/>

means that a filter called lc (land cover) can be applied to the query with a numeric value for the requested percentage of land cover in the dataset.

Practically, with opensearch-client:

opensearch-client -p lc=[40, https://catalog.terradue.com/sentinel1/search identifier

will return the datasets with content over areas having a land cover of 40% or more.