Skip to content

Describes how to comply to the CEOS-ARD specifications with STAC. Supersedes the STAC CARD4L extension.

License

Notifications You must be signed in to change notification settings

stac-extensions/ceos-ard

Repository files navigation

CEOS-ARD Extension Specification

This document explains the CEOS-ARD Extension to the SpatioTemporal Asset Catalog (STAC) specification. It specifies how to create STAC Items and Collections that comply to the various CEOS-ARD product family specifications.

It is planned that this extension supersedes the existing CARD4L extension, which itself is planned to be deprecated. WORK IN PROGRESS

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

The fields don't need to be provided in each Item to minimize the required changes in the Items. The fields can be provided in the Items to make the fields available in search.

Field Name Data Type Description
ceosard:type string REQUIRED. The CEOS-ARD (sensor) type implemented, one of optical or radar.
ceosard:specification string REQUIRED. The CEOS-ARD product family specification implemented.
ceosard:specification_version string REQUIRED. The CEOS-ARD product family specification version implemented.

The following combinations of values are supported for the fields above:

PFS ceosard:type ceosard:specification ceosard:specification_version STAC Status
Surface Reflectance optical SR 5.0 / 5.0.1 Proposal
Surface Temperature optical ST 5.0 Proposal
Aquatic Reflectance optical AR 1.0 Proposal
Nighttime Lights Surface Radiance optical NLSR 1.0 Proposal
LiDAR Terrain and Canopy Top Height optical LIDAR-TCTH Unreleased Reserved
Combined SAR: Normalised Radar Backscatter (NRB) radar NRB 1.0 WIP
Combined SAR: Polarimetric Radar (POL) radar POL 1.0 WIP
Combined SAR: Ocean Radar Backscatter (ORB) radar ORB 1.0 WIP
Combined SAR: Geocoded Single-Look Complex (GSLC) radar GSLC 1.0 WIP
Combined SAR: Interferometric Radar (INSAR) radar INSAR Unreleased Reserved

Profiles

Additional requirements for CEOS-ARD are specified in the corresponding STAC profiles:

One of the profiles above must be implemented.

Relation types

The following types must be used as applicable rel types in the Link Object.

Type Description
ceos-ard-specification REQUIRED. Provides at least one link to the applicable CEOS-ARD specification document. Word (media type: application/vnd.openxmlformats-officedocument.wordprocessingml.document) and/or PDF (media type: application/pdf).

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

About

Describes how to comply to the CEOS-ARD specifications with STAC. Supersedes the STAC CARD4L extension.

Resources

License

Stars

Watchers

Forks

Packages

No packages published