Parameters mapping

Parameters mapping#

eodag interacts with various data providers, each having its own way of naming and structuring metadata parameters. To provide a unified interface for users, eodag maps these provider metadata parameters to a common model.

Parameters mapping#

EODAG maps each provider’s specific metadata parameters to a common model using OGC OpenSearch Extension for Earth Observation. Extra parameters having no equivalent in this model are mapped as is.

Depending on the provider, some parameters are queryable or not. This is configured in providers.yml:

If a parameter metadata-mapping is a list, the first element will help constructing the query (using format()), and the 2nd will help extracting its values from the query result (using jsonpath)
If a parameter metadata-mapping is a string, it will not be queryable and this string will help extracting its values from the query result (using jsonpath).

some_provider:
   search:
      metadata_mapping:
         queryableParameter:
            - 'this_is_query_string={queryableParameter}'
            - '$.jsonpath.in.result.to.parameter'
         nonQueryableParameter: '$.jsonpath.in.result.to.another_parameter'

Formatters#

An EOProduct has a properties attribute which is built based on how its metadata are set in the provider configuration. For example:

search:
   ...
   metadata_mapping:
      publicationDate: '{$.data.timestamp#to_iso_utc_datetime_from_milliseconds}'
      ...

The following converters can be used to transform the values collected from the provider:

eodag.api.product.metadata_mapping.format_metadata(search_param, *args, **kwargs)[source]#

Format a string of form {<field_name>#<conversion_function>}

The currently understood converters are:

ceda_collection_name: generate a CEDA collection name from a string
csv_list: convert to a comma separated list
datetime_to_timestamp_milliseconds: converts a utc date string to a timestamp in milliseconds
dict_filter_and_sub: filter dict items using jsonpath and then apply recursive_sub_str
fake_l2a_title_from_l1c: used to generate SAFE format metadata for data from AWS
from_alternate: update assets using given alternate
from_ewkt: convert EWKT to shapely geometry / WKT in DEFAULT_PROJ
from_georss: convert GeoRSS to shapely geometry / WKT in DEFAULT_PROJ
get_ecmwf_time: get the time of a datetime string in the ECMWF format
get_group_name: get the matching regex group name
recursive_sub_str: recursively substitue in the structure (e.g. dict) values matching a regex
remove_extension: on a string that contains dots, only take the first part of the list obtained by splitting the string on dots
replace_str: execute “string”.replace(old, new)
s2msil2a_title_to_aws_productinfo: used to generate SAFE format metadata for data from AWS
sanitize: sanitize string
slice_str: slice a string (equivalent to s[start, end, step])
split_cop_dem_id: get the bbox by splitting the product id
split_corine_id: get the product type by splitting the product id
to_bounds_lists: convert to list(s) of bounds
to_datetime_dict: convert a datetime string to a dictionary where values are either a string or a list
to_ewkt: convert to EWKT (Extended Well-Known text)
to_geojson: convert to a GeoJSON (via __geo_interface__ if exists)
to_iso_date: remove the time part of a iso datetime string
to_iso_utc_datetime_from_milliseconds: convert a utc timestamp in given milliseconds to a utc iso datetime
to_iso_utc_datetime: convert a UTC datetime string to ISO UTC datetime string
to_lower: Convert a string to lowercase
to_nwse_bounds_str: convert to North,West,South,East bounds string with given separator
to_nwse_bounds: convert to North,West,South,East bounds
to_rounded_wkt: simplify the WKT of a geometry
to_title: Convert a string to title case
to_upper: Convert a string to uppercase

Parameters:

search_param (str) – The string to be formatted
args (Any) – (optional) Additional arguments to use in the formatting process
kwargs (Any) – (optional) Additional named-arguments to use when formatting

Return type:

str

Returns:

The formatted string

Queryables#

The list_queryables() method will help you to dynamically check which parameters are queryable for a given provider or product type. See Python API User Guide / Queryables for more information and examples.

The following static tables list the parameters supported by providers, and if they are queryable or not.

OpenSearch parameters (CSV)#

parameter	cop_dataspace	creodias	earth_search	earth_search_gcs	eumetsat_ds	fedeo_ceda	geodes	peps	planetary_computer	sara	usgs_satapi_aws
abstract			metadata only	metadata only		metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
accessConstraint								metadata only		metadata only
acquisitionStation			queryable metadata	queryable metadata		queryable metadata	queryable metadata		queryable metadata		queryable metadata
acquisitionSubType			queryable metadata	queryable metadata		queryable metadata	queryable metadata		queryable metadata		queryable metadata
acquisitionType								metadata only		metadata only
availabilityTime			queryable metadata	queryable metadata		queryable metadata	queryable metadata		queryable metadata		queryable metadata
cloudCover	queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
completionTimeFromAscendingNode	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
creationDate			queryable metadata	queryable metadata		queryable metadata	queryable metadata	metadata only	queryable metadata	metadata only	queryable metadata
doi			queryable metadata	queryable metadata		queryable metadata	queryable metadata		queryable metadata		queryable metadata
dopplerFrequency			queryable metadata	queryable metadata		queryable metadata	queryable metadata		queryable metadata		queryable metadata
illuminationAzimuthAngle			queryable metadata	queryable metadata		queryable metadata	queryable metadata		queryable metadata		queryable metadata
illuminationElevationAngle			queryable metadata	queryable metadata		queryable metadata	queryable metadata		queryable metadata		queryable metadata
instrument	queryable metadata	queryable metadata	queryable metadata	queryable metadata	metadata only	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
keyword							metadata only	metadata only		metadata only
modificationDate	queryable metadata	metadata only	queryable metadata	queryable metadata	metadata only	queryable metadata	queryable metadata	metadata only	queryable metadata	metadata only	queryable metadata
orbitDirection	queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
orbitNumber	queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
organisationName	queryable metadata	queryable metadata						queryable metadata		queryable metadata
parentIdentifier					queryable metadata			queryable metadata		queryable metadata
platform	queryable metadata	queryable metadata	queryable metadata	queryable metadata	metadata only	queryable metadata	queryable metadata	metadata only	queryable metadata	metadata only	queryable metadata
platformSerialIdentifier	queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
processingCenter								metadata only		metadata only
processingLevel	queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
processorName								metadata only		metadata only
productQualityStatus								metadata only		metadata only
productType	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
productVersion			queryable metadata	queryable metadata		queryable metadata	queryable metadata	metadata only	queryable metadata	metadata only	queryable metadata
publicationDate	metadata only	metadata only	queryable metadata	queryable metadata		queryable metadata	queryable metadata	metadata only	queryable metadata	metadata only	queryable metadata
resolution	queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
sensorMode	queryable metadata	queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
snowCover								queryable metadata		queryable metadata
startTimeFromAscendingNode	queryable metadata	queryable metadata	metadata only	metadata only	queryable metadata	metadata only	queryable metadata	queryable metadata	metadata only	queryable metadata	metadata only
swathIdentifier							queryable metadata	queryable metadata		queryable metadata
title	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
topicCategory								metadata only		metadata only

Provider/eodag specific parameters (CSV)#

parameter	cop_dataspace	cop_marine	creodias	earth_search	earth_search_gcs	eumetsat_ds	fedeo_ceda	geodes	peps	planetary_computer	sara	usgs_satapi_aws
acquisitionInformation						metadata only
assets				metadata only	metadata only	metadata only	metadata only	metadata only		metadata only		metadata only
awsProductId												metadata only
collection	queryable metadata		queryable metadata
defaultGeometry		metadata only				metadata only
downloadLink	metadata only		metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
extraInformation						metadata only
geometry	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	metadata only	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
gridSquare				queryable metadata
id	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
latitudeBand				queryable metadata
links									metadata only
modifiedAfter	queryable metadata
modifiedBefore	queryable metadata
polarizationChannels	queryable metadata		queryable metadata	queryable metadata	queryable metadata		queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata	queryable metadata
productIdentifier	metadata only		metadata only
productInformation						metadata only
providerProductType								queryable metadata
publishedAfter	queryable metadata
publishedBefore	queryable metadata
quicklook	metadata only		metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
relativeOrbitNumber	queryable metadata							queryable metadata
services									metadata only
size						metadata only
storageStatus	metadata only		metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
thumbnail	metadata only		metadata only	metadata only	metadata only		metadata only	metadata only	metadata only	metadata only	metadata only	metadata only
tileIdentifier	queryable metadata		queryable metadata	queryable metadata				queryable metadata	queryable metadata	queryable metadata
type						metadata only
uid	metadata only		metadata only			metadata only		metadata only	metadata only		metadata only
utmZone				queryable metadata

Parameters mapping

Contents

Parameters mapping#