This document explains the fields of the EOPF extension to the SpatioTemporal Asset Catalog (STAC) specification.
EOPF is the framework of Copernicus Sentinel data processors under development by ESA. See EOPF site for context.
It is strongly recommended to use the other STAC extensions eo, view, processing, sat and sci with the eopf extension.
Field Name | Type | Description |
---|---|---|
eopf:resolutions | object | Dictionary of ground resolutions |
eopf:type | string | Product type |
eopf:timeline | string | Processing timeline indicator |
eopf:baseline | string | Processing baseline identifier |
eopf:data_take_id | string | Unique acquisition identifier |
eopf:instrument_mode | string | Instrument mode |
eopf:instrument_swath | string | Instrument swath |
eopf:image_size | [Image Size Object] | Image sizes in pixels |
eopf:pixel_classification | [Pixel Quality Object] | Pixel quality classification |
eopf:resolutions
provides a dictionary of image spatial ground resolution, in m, per type of image in the product.
This dictionary allows to list ground-resolution values for all named rasters contained in the data.
If the product contains only one type of image, gsd
can be used instead.
eopf:timeline
provides the information on the processing time lapse.
It can be Near Real Time (NRT), Short Time Critical (STC), Non Time Critical (NTC), etc.
eopf:baseline
provides the identification of the processing baseline, linked to specific versions and configurations.
eopf:image_size
provides the sizes in rows and columns of each image in the product, as well as its position.
An Item is only allowed to use eopf:image_size
in its Properties if it has at least one asset with a defined image size array.
This field contains at least the raster dimensions in x (columns) and y (rows) for the highest resolution data in the product.
For multi-resolution data or rasters containing tie-point variables, the complete list of sizes can be provided too.
Optionally, the extract position of the image in offsets for element (0,0) on the swath can be provided too.
eopf:pixel_classification
provides the amount of pixels with a quality class, in counts and / or in percentage, related to the best resolution raster.
An Item is only allowed to use eopf:pixel_classification
in its Properties if it has at least one asset with a defined pixel class array.
This field contains the classification structure with a short name for each class.
In case of multiple raster sizes, this structure contains only the classes for the highest resolution data.
One of the fields, count or percent, is required to be set, but both can be used at the same time.
Field Name | Type | Description |
---|---|---|
name | string | The name of the image (e.g. "B01", "band2", "red", "nadir"). |
start_offset | number | Position of element (0,*) wrt product start |
track_offset | number | Position of element (*,0) wrt sub-satellite track |
rows | number | Number of rows |
columns | number | Number of columns |
Field Name | Type | Description |
---|---|---|
name | string | The name of the pixel quality class |
count | number | Number of pixels affected by flag |
percent | number | Percentage of pixels affected by flag |
All contributions are subject to the STAC Specification Code of Conduct. For contributions, please follow the STAC specification contributing guide Instructions for running tests are copied here for convenience.
The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid.
To run tests locally, you'll need npm
, which is a standard part of any node.js installation.
First you'll need to install everything with npm once. Just navigate to the root of this repository and on your command line run:
npm install
Then to check markdown formatting and test the examples against the JSON schema, you can run:
npm test
This will spit out the same texts that you see online, and you can then go and fix your markdown or examples.
If the tests reveal formatting problems with the examples, you can fix them with:
npm run format-examples