Skip to content

stac-extensions/sentinel-1

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sentinel-1 Extension Specification

This document explains the Sentinel-1 Extension to the SpatioTemporal Asset Catalog (STAC) specification.

Caution

The intention of the first version of the specification was to reflect the existing behavior of the properties prefixed with s1 as implemented by the stactools-sentinel1 package. The following version deprecated most of the fields in favor of other extensions that are not specific to Sentinel-1. The remaining fields are highly specific and usually not of interest of an average user. As such implementors should only implement the fields that they think bring value to their users. Many implementations may not need to implement this extension at all.

Fields

The fields in the table below can be used in these parts of STAC documents:

  • Catalogs
  • Collections
  • Item Properties (incl. Summaries in Collections)
  • Assets (for both Collections and Items, incl. Item Asset Definitions in Collections)
  • Links
Field Name Type Description
s1:datatake_id string e.g. 420895
s1:instrument_configuration_ID string e.g. 7
s1:orbit_source string e.g. PREORB
s1:slice_number string e.g. 17
s1:total_slices string e.g. 17
s1:resolution string DEPRECATED Expose gsd, spatial_resolution (raster extension), and/or sar:resolution_range sar:resolution_azimuth (SAR extension) instead. The mapping is available in Table B.1 of the Sentinel-1 documentation.
s1:product_identifier string DEPRECATED Use Item id or link to source products instead (e.g. relation types via or derived_from)
s1:product_timeliness string DEPRECATED Use product:timeliness_category and product:timeliness instead
s1:processing_datetime string DEPRECATED Use processing:datetime instead
s1:processing_level string DEPRECATED Use processing:level instead
s1:shape [integer] DEPRECATED Use proj:shape instead

s1:resolution: Either full (Full Resolution - SM mode), high (High Resolution - SM, IW and EW mode), or medium (Medium Resolution - SM, IW, EW and WV modes)

Contributing

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.

Running tests

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