Skip to content

Latest commit

 

History

History
310 lines (202 loc) · 24 KB

README.md

File metadata and controls

310 lines (202 loc) · 24 KB

STAC Extensions

The stac-extensions GitHub organization is a home for extensions to the SpatioTemporal Asset Catalog specification.

To learn about STAC and Extensions start with the extensions section of the core specification. It explains how extensions work, lists all the known extensions, and has instructions for how to go about 'extending STAC'.

The stac-extensions GitHub organization is a home for many of the leading 'community extensions', providing a neutral home for collaboration. Many of these used to be in the core stac-spec repository, but were removed for 1.0.0 so they could evolve at their own pace, instead of having to follow the core STAC release cycle.

List of STAC Extensions

This is meant to be the definitive list of STAC Extensions, but not all of them may be part of this GitHub organization.

An asterisk (*) indicates a community extension that is hosted externally. As such is not part of the stac-extensions GitHub organization and may not follow the normal procedure or classification for STAC extensions, e.g. regarding the maturity.

Below you can also find a list of extensions grouped by maturity.

Alphabetical list

Title Field Name Prefix Scope Maturity Version Description
Accuracy accuracy Collection, Item Proposal 1.0.0-beta.1 Fields to provide estimates of accuracy, both geometric and measurement (e.g., radiometric) accuracy.
Aerial Photography* aerial-photo Collection, Item WIP Unknown Aerial photography related metadata, such as run, sequence number, altitude and scale.
Alternate Assets alternate` Collection, Item Pilot 1.2.0 Describes alternate locations and mirrors of assets
Altimetry altm Item Proposal 0.1.0 Altimetry Extension Specification
Anonymized Location anon Collection, Item Pilot 1.0.0 Provides a way to anonymize location data
Archive archive Collection, Item WIP Unreleased Archive extension that deals with cases when files are not directly accessible on their respective storage, but are part of an archive file, such as ZIP or TAR archives.
Attribution - Collection, Item Proposal 0.1.0 Allows to provide an attribution, e.g. for maps, compliant with OGC API Collections
Authentication auth Asset, Catalog, Collection, Item, Links Proposal 1.1.0 Adds fields to define authentication or authorization flows used to access Assets and Links behind security
CARD4L (Optical and SAR) card4l Item Pilot 0.1.0 Describes how to comply to the CEOS CARD4L specifications (SAR and Optical) with STAC
CEOS-ARD ceosard Collection, Item Proposal 0.2.0 Describes how to comply to the CEOS-ARD specifications with STAC. Supersedes the STAC CARD4L extension.
CF cf Collection, Item Proposal 0.2.0 Allows to provide the Standard Name Table based on the CF metadata convention.
CMIP6 cmip6 Item WIP Unreleased None
Camera* camera Collection, Item WIP Unknown Camera related metadata, such as focal length and sequence number. Especially useful for aerial imagery surveys.
Classification classification Collection, Item Pilot 2.0.0 Describes categorical values and bitfields to give values in a file a certain meaning (classification).
Composite composite Item WIP Unreleased Defines how virtual assets can be composed from existing assets in STAC
Contacts - Catalog, Collection, Item Proposal 0.1.1 A list of contacts with detailed information such as address, phone numbers, emails etc.
Datacube cube Collection, Item Candidate 2.2.0 Datacube related metadata to describe their dimensions and variables.
Deep Learning Model Extension* dlm Asset, Collection, Item, Links Deprecated 1.0.0 Deep Learning Model STAC Extension (deprecated, see https://github.com/stac-extensions/mlm instead)
Disasters Charter* disaster Collection, Item Proposal 1.1.0 Disaster Charter Extension Specification
Earthquake eq Collection, Item WIP Unreleased Earthquake Extension Specification
Electro-Optical eo Collection, Item Stable 2.0.0 Covers electro-optical data that represents a snapshot of the Earth. It could consist of cloud cover and multiple spectral bands, for example visible bands, infrared bands, red edge bands and panchromatic bands.
Example Links example Catalog, Collection, Item Proposal 0.0.1 Allows to provide links to examples, e.g. code snippets.
File Info file Catalog, Collection, Item Stable 2.1.0 Specifies file-related details such as size, data type and checksum for assets and links in STAC.
Film* film Collection, Item WIP Unknown Film related metadata, such as roll, negative sequence and other physical attributes. Especially useful for digitised historic aerial imagery surveys.
Forecast forecast Collection, Item Proposal 0.1.0 Common fields for (meteorological/weather) forecast data.
Grid grid Item Pilot 1.1.0 Describes gridded data products, especially the grid code.
Hyperspectral Imagery hsi Collection, Item WIP Unreleased Extension for Hyperspectral Imagery, to preserve the wavelength information for Items.
InSAR insar Item Proposal 1.0.0 STAC extension for InSAR (Interferometric Synthetic Aperture Radar)
Item Assets Definition - Collection Deprecated 1.0.0 Provides a way to specify details about what assets may be found in Items belonging to a Collection.
Label label Collection, Item Pilot 1.0.1 Items that relate labeled AOIs with source imagery.
Landsat landsat Item Stable 2.0.0 Landsat data fields
Landsat* landsat Unknown Unknown 1.1.1 JSON Schema only!
Landsat ARD Tile* landsat Unknown Unknown 1.0.0 JSON Schema only!
Language (I18N) - Catalog, Collection, Item Proposal 1.0.0 Fields and recommendations around making multi-lingual STAC catalogs available.
ML AOI ml-aoi Asset, Collection, Item, Links Proposal 0.2.0 An Item and Collection extension to provide labeled training data for machine learning models.
ML Model ml-model Collection, Item Proposal 1.0.0 An Item and Collection extension to describe machine learning (ML) models that operate on Earth observation data.
Machine Learning Model Extension mlm Asset, Collection, Item, Links Pilot 1.3.0 STAC Machine Learning Model (MLM) Extension to describe ML models, their training details, and inference runtime requirements.
Machine Learning Model Extension* mlm Asset, Collection, Item, Links Pilot 1.3.0 Machine Learning Model STAC Extension (archive, see https://github.com/stac-extensions/mlm)
Military Grid Reference System mgrs Item Pilot 1.0.0 MGRS extension that provides information about the latitude band, grid square and UTM zone.
NOAA Geostationary Operational Environmental Satellite (GOES) goes Collection, Item Pilot 1.0.0 STAC Extension for NOAA GOES (Geostationary Operational Environmental Satellite) products
NOAA MRMS QPE noaa_mrms_qpe Collection, Item Pilot 1.0.0 STAC Extension for NOAA MRMS QPE (Multi-Radar Multi-Sensor Quantitative Precipitation Estimation) products
Open Science Catalog osc Catalog, Collection, Item Proposal 1.0.0-rc.3 STAC Extension for the ESA Open Science Catalog
Order order Collection, Item Pilot 1.1.0 Allows assets ordering management within STAC specification.
Perspective Imagery pers Collection, Item Proposal 1.0.0 Describes perspective imagery collected by photogrammetric or non-photogrammetric cameras
Point Cloud pc Collection, Item Pilot 2.0.0 Provides a way to describe point cloud datasets. The point clouds can come from either active or passive sensors, and data is frequently acquired using tools such as LiDAR or coincidence-matched imagery.
Processing processing Collection, Item Candidate 1.2.0 Indicates from which processing chain data originates and how the data itself has been produced.
Product product Collection, Item Proposal 0.1.0 Generic Product-related properties for STAC
Projection proj Collection, Item Stable 2.0.0 Provides a way to describe Items whose assets are in a geospatial projection.
Quality* quality Collection Proposal Unknown Geospatial quality and accuracy of collections, such as horizontal and vertical accuracy.
Raster raster Collection, Item Candidate 2.0.0 Describes raster assets at band level (one or multiple) with specific information such as data type, unit, number of bits used, nodata.
Rendering renders Collection, Item Proposal 1.0.0 Provide consumers with the information required to view an asset properly (e.g. on a online map)
SAR sar Collection, Item Candidate 1.0.0 Covers synthetic-aperture radar data that represents a snapshot of the earth for a single date and time.
Satellite sat Collection, Item Candidate 1.0.0 Satellite related metadata for data collected from satellites.
Scanning* scan Collection, Item WIP Unknown Scanning related metadata, such as the scan date and time. Especially useful for digitised images.
Scientific Citation sci Collection, Item Stable 1.0.0 Metadata that indicate from which publication data originates and how the data itself should be cited or referenced.
Sentinel-1 s1 Item Proposal 0.2.0 Sentinel-1 STAC Extension
Sentinel-2 s2 Item Candidate 1.0.0 Sentinel-2 STAC Extension
Sentinel-3 s3 Item Deprecated 0.2.0 Sentinel-3 STAC Extension
Sentinel-5P s5p Item Proposal 0.2.0 Sentinel-5P STAC Extension
Single File STAC - Collection, Item Deprecated Unreleased An extension to provide a set of Collections and Items within a single file STAC.
Solar System ssys Catalog, Collection, Item Proposal 1.1.0 SSYS STAC Extension Specification
Stats stats Catalog, Collection Pilot 0.2.0 Describes the number of items, extensions and assets that are contained in a STAC catalog.
Stereo Imagery stereo-img Catalog, Collection, Item Proposal 1.0.0 Describes (tri-)stereo imagery that consists of multiple captures, often for 3D use cases.
Storage storage Catalog, Collection, Item Pilot 2.0.0 Provides additional fields relating to how the asset is stored in the cloud
Table table Collection, Item Pilot 1.2.0 Describes tabular data assets using a list of Column objects. Tables can be specified in Collections.
Themes - Catalog, Collection, Item Proposal 1.0.0 A knowledge organization system used to classify the resource (controlled vocabularies / keywords)
Tiled Assets tiles Catalog, Collection, Item Proposal 1.0.0 Allows to specify numerous assets using asset templates via tile matrices and dimensions.
Time Series ts Collection, Item Deprecated Unreleased Time Series STAC Extension Specification
Timestamps - Catalog, Collection, Item Pilot 1.1.0 Allows to specify numerous additional timestamps for assets and metadata.
TrainingDML-AI* tdml Collection, Item Proposal 1.0.0 Detailed metadata for formalizing the information model of geospatial EO machine learning training data.
U.S. Fish & Wildlife Service (FWS) National Wetlands Inventory (NWI) fws_nwi Collection, Item Proposal 1.0.0 Describes the U.S. Fish & Wildlife Service (FWS) National Wetlands Inventory (NWI) products
Versioning Indicators - Collection, Item Candidate 1.2.0 Provides fields and link relation types to provide a version and indicate deprecation.
Video video Collection, Item Proposal 1.0.0 Provides a way to describe video assets.
View Geometry view Collection, Item Stable 1.0.0 View Geometry adds metadata related to angles of sensors and other radiance angles that affect the view of resulting data.
Virtual Assets vrt Collection, Item Proposal 1.0.0 Allows the description of virtual assets composed from 2 or more assets with cross references and repositioning.
Web Map Links none, but each relat Catalog, Collection, Item Proposal 1.2.0 Allows to provide links to web maps for visualization purposes
xarray Assets xarray Asset Pilot 1.0.0 This extension helps users open STAC Assets with xarray. It gives a place for catalog maintainers to specify various required or recommended options.
  • Last updated: Nov 06 2024, 01:11
  • Count: 77

Grouped by maturity

Stable

Candidate

Pilot

Proposal

WIP

Deprecated

Adding a new extension

The general idea on how to extend STAC and propose new extensions is explained on the page about extensions in the stac-spec repository.

Using the stac-extensions template

Create the repository:

  • Go to template repository, hit the green 'Use this template' button and choose 'Create a new repository'.
  • Be sure to pick the right place ('Owner' and 'Repository name') to create it. You can request (via Gitter or e-mail) to become a member of the stac-extensions organization or put the next repository under your personal account or any other organization.
  • Add a concise and clear description of the extension, it will be used as a description in the list above!
  • Click 'Include all branches' for the CI to write correctly.
  • Finish this by clicking the 'Create repository from template' button

Write your extension:

  • In the repository 'Settings' go to 'Pages' and set the 'Source' to 'Deploy from a branch' and for the 'Branch' select 'gh-pages' and '/ (root)'
  • Update the title, identifier, field name prefix, scope, and owner. Don't mess around with the formatting or structure as this will be used to generate the table above!
  • Update the fields, select where they can be used, add documentation, etc. in the README.md
  • Update the JSON Schema accordingly in schemas/schema.json
  • Add examples
  • Go through the files and update everything that is still named 'template' (the easiest way is to let an IDE/Editor search through all the files for 'template')
  • Run the tests
  • Update the changelog
  • Let people discuss your extension, e.g. via Gitter
  • Eventually, release the extension via GitHub Releases

You can add external/community extensions to the list above by editing the config file and creating a Pull Request for the change. All extensions hosted in the stac-extensions organization will be added automatically each night.