Collections

The FarEarth Catalogue extends the STAC collections concept to enable searching for any data in a datastore.

It is also possible to search for external STAC compliant catalogues in this way.

Collections are also the primary method of granting another subscription access files within your archive. This is achieved by sharing the collection resource with another subscription, allowing you to control exactly what kind of products other users should have access to without setting up a dedicated archive.

See how-to add new collection for instructions on how to configure a new collection.

Examples

Filter on dataset

In this example, the collection includes all data with a dataset field equal to qa-data.

{
    "details": {
        "id": "my.collection",
        "title": "My collection",
        "description": "Short description of my collection"
    },
    "filter": {
        "query": {
            "dataset": {
                "eq": "qa-data"
            }
        }
    }
}

Filter on spacecraft and product type

This example shows a collection with a compound filter. All conditions of the query must match (AND query). Only L1A products, from the TRUBIT-1 spacecraft, which are stored within the trueorbit subscription will be provided.

{
    "details": {
        "id": "farearth.trubit-1-l1a",
        "title": "TRUBIT-1-l1a",
        "description": "",
        "shareable": true        
    },
    "filter": {
        "query": {
            "productType": {
                "eq": "L1A"
            },
            "spacecraft": {
                "eq": "TRUBIT-1"
            },
            "subscriptionId": {
                "eq": "trueorbit"
            }
        }
    }
}

External STAC collection

This is an example of proxying data from an external STAC catalog. The proxy is configured to expose the Element84 Copernicus DEM GLO-30 data, using the AWS Earth Search API.

{
    "details": {
        "id": "farearth.cop-dem-glo-30",
        "title": "Copernicus DEM GLO-30",
        "description": "The Copernicus DEM is a Digital Surface Model (DSM) which represents the surface of the Earth including buildings, infrastructure and vegetation"
    },
    "proxy": {
        "sourceId": "e84-aws-v1",
        "sourceTitle": "AWS Earth Search API (v1)",
        "baseUrl": "https://earth-search.aws.element84.com/v1"
    }
}

Below is another example proxying the USGS STAC Server for the Landsat Collection 2 Level 1 products.

{
    "details": {
        "id": "farearth.landsat-c2l1",
        "title": "Landsat Collection 2 L1 products",
        "description": "Landsat Collection 2 L1 products"
    },
    "proxy": {
        "sourceId": "usgs.landsat-c2l1",
        "sourceTitle": "USGS STAC Server",
        "baseUrl": "https://landsatlook.usgs.gov/stac-server"
    }
}

Collection details

The table below lists the various fields in a collection configuration.

Field	Example Value	Details
filter	query	There are multiple available query parameters, that a creator can also link together to create more in depth limited scope searches with. Examples of such query parameters are:
proxy	sourceId sourceTitle baseUrl	Using external data source providers, there are a few required parameters to access their STAC compliant servers namely:

The query field can include a number of parameters:

Parameter	Example value	Details
productType	RAW L0 L1A L1C	Search for a specific product type
spacecraft	TRUEBIT-1	Search for a specific spacecraft
subscriptionId	farearth trueorbit	Search within a specific subscription

The proxy field must include the following fields:

Parameter	Details
sourceId	Unique ID of the data source within a STAC catalog
sourceTitle	Name associated with the data source
baseUrl	STAC API endpoint of the source