GBDX

LANDSAT-8 (retired from GBDX)

DEC 14, 2020 This dataset has been removed from GBDX and is no longer available.

IMPORTANT: This imagery dataset has been deprecated from GBDX and will be removed from our platform on December 14, 2020. Read the deprecation announcement.

Table of Contents

Overview

For information on the Landsat-8 dataset on AWS, see Landsat 8 on AWS

Landsat imagery courtesy of NASA Goddard Space Flight Center and U.S. Geological Survey or USGS/NASA Landsat

Quickstart Examples

In these examples, "Landsat8" is the value for "item_type" and "types."

GBDXtools

This example shows how to search for Landsat-8 data using GBDXtools:

Python

from gbdxtools import Interface
gbdx = Interface()

aoi = "POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))"
query = 'item_type:Landsat8'
images = gbdx.vectors.query(aoi, query)  

print('Images: {}'.format(len(images)))
print("Show first return!")
images[0]

The response to this query displays the properties for a Landsat image. You can find the catalog ID and the product ID in the properties.

See GBDXtools Response example

VectorService API

Using the GBDX VectorService API, search by "item_type" to find LANDSAT data. To narrow down the search results set, include area, date range, or both. Search results can be further filtered by data attributes, can be sorted by properties, and the number of results returned can be set.

Vector Services Index Query Reference Overview

API Headers:

Authorization: Bearer [[token]]
Content-type: application/json

To retrieve a subset of results, send a POST request to

https://vector.geobigdata.io/insight-vector/api/index/query/vector-gbdx-alpha-catalog-v2*/items?q=item_type:Landsat8&count=1

with a request body.This is an example:

JSON

{
    "coordinates": [[[-105.35202026367188, 39.48113956424843], [-105.35202026367188, 40.044848254075546], [-104.65988159179688, 40.044848254075546], [-104.65988159179688, 39.48113956424843], [-105.35202026367188, 39.48113956424843]]],
    "type": "Polygon"
}

See Vector Services Response example

To retrieve all results, use a paging request instead. Send a POST request to

https://vector.geobigdata.io/insight-vector/api/index/query/vector-gbdx-alpha-catalog-v2*/paging?q=item_type:Landsat81&ttl=5m&sort=item_date:asc

JSON

{
    "coordinates": [[[-105.35202026367188, 39.48113956424843], [-105.35202026367188, 40.044848254075546], [-104.65988159179688, 40.044848254075546], [-104.65988159179688, 39.48113956424843], [-105.35202026367188, 39.48113956424843]]],
    "type": "Polygon"
}

Catalog API

Using the GBDX Catalog API, search by "types." To narrow the search results set, include area, date range, or both. Search results can be further filtered by properties.

API Headers:

Authorization: Bearer [[token]]
Content-type: application/json

Send a POST request to

https://geobigdata.io/catalog/v2/search

with a request body. This is an example:

    {
    "searchAreaWkt": "POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))",
    "startDate": "2018-11-01T00:00:00.000Z",
    "endDate": "2018-12-31T23:59:59.999Z",
    "types": ["Landsat8"]
     }

See Catalog API Response Example

Back to top

Types

These are the types associated with Landsat-8 data.

TypeDefinition
GBDXcatalog recordThe parent type for all records in the GBDX catalog
AcquisitionThe parent type for all acquisition records
Landsat8All Landsat-8 records
LandsatAcquisitionAll Landsat-8 acquisitions*

*All Landsat-8 records are cataloged by GBDX as acquisitions. Searching by Landsat8 and LandsatAcquisition returns the same results.

Back to top

Properties

The following properties are associated with a Landsat image in the GBDX catalog and appear in the response to a Catalog API request. The responses from a Vector Services API request or a GBDXtools request have minor differences.

PropertyValues
browseURLThe url to view the Landsat image thumbnail
bucketNameThe name of the AWS bucket where Landsat data is stored. The value is "landsat-pds" for all Landsat images.The bucketName and bucketPrefix make up what we refer to as the S3 location.
bucketPrefixThe folder within the S3 bucket where the image and its metadata are stored. For the collection 1 archive (recommended) the prefix starts with "c1."
catalogIDThe unique identifier for the image in the GBDX catalog. The value for "catalogID and "identifier" are the same.
cloudCoverThe percentage of cloud cover detected in the image
footprintWKTThe multipolygon geometry for in image in WKT format
identifierThe unique identifier for the record in the GBDX catalog. This is also referred to as the catalog ID. Ex. LC80330332018107LGN00
multiresolutionThe multispectral resolution of a Landsat-8 image is 30 meters
panResolutionThe panchromatic resolution for the image is 15 meters
pathThe WRS path. A Landsat scene corresponds to the path and row for the image.
platformNameThe name of the satellite that acquired the image. The format and value are "LANDSAT08."
productIDThe product ID assigned to the Landsat image. See "Product ID" below for an explanation of the naming convention.
rowThe WRS row. A landsat scene corresponds to the path and row for the image.
sensorPlatformNameThe name of the satellite that acquired the image. The format and value are "LANDSAT08."
timestampThe date and time the data was acquired by the satellite
vendorLandsat

Identifiers

There are three identifiers associated with a Landsat record in the GBDX catalog:

Identifier NameDescription
catalogIDThe unique identifier for the record in the GBDX catalog
identifierFor Landsat records, the "identifier" is the same as the catalog ID
productIDFor Landsat-8 collection 1 records, the product ID is used to provide information about the image and its quality. For the precollection dataset, the product ID is the same value as the catalog ID. More information on the product ID is provided below.

Catalog ID

The Catalog ID is unique ID for the record assigned by the vendor. For Landsat data, the catalog ID is what USGS refers to as the Landsat scene ID. This is an example of a Landsat-8 catalog ID. Landsat refers to this as a "scene number".

LC80330322014336LGN00

The components of the identifier indicate the following: satellite, sensor, row, path, date acquired, the receiving station, and the archive number. For more information, see Landsat File Naming Convention.

GBDXtools users: The CatalogImage class accepts a Landsat catalogID.

Identifier

For Landsat records, the identifier property is the same as the catalog ID.

Product ID

The Landsat-8 Collection 1 dataset archive is cataloged on GBDX. For this archive, the product ID uses a naming convention that identifies the satellite, sensor, tier level, row, path, date acquired, date processed, and tier quality.

This is an example of a Collection 1 product ID:

LC08_L1TP_034032_20181102_20181115_01_T1

See Landsat on AWS for a detailed look at the naming convention.

GBDXtools users: The LandsatImage base class accepts a product ID. If you have a product ID, but not a catalog ID, use this class instead of CatalogImage.

Note: The GBDX catalog includes some older records from the deprecated pre-collection dataset. The records use the catalog ID (or scene ID) as the product ID. All pre-collection records were reprocessed into the Collection 1 dataset.

S3 Location

The s3 location for Landsat data is the bucketName and bucketPrefix.

For example:

  • Bucket name: landsat-pds
  • BucketPrefix: L8/034/033/LC80340332014359LGN0
  • S3 location: s3://landsat-pds/L8/034/033/LC80340332014359LGN0

Back to top

Response Examples

GBDXtools Response Example

PYTHON

Images: 100
Show first return!
{'type': 'Feature',
 'geometry': {'type': 'Polygon',
  'coordinates': [[[-105.138, 41.289],
    [-105.621, 39.69],
    [-103.412, 39.369],
    [-102.879, 40.96],
    [-105.138, 41.289]]]},
 'properties': {'ingest_source': 'GBDX_INGEST_ALPHA',
  'item_date': '2019-02-15T17:37:02.350Z',
  'original_crs': 'EPSG:4326',
  'item_type': ['GBDXCatalogRecord',
   'Acquisition',
   'Landsat8',
   'LandsatAcquisition'],
  'name': None,
  'format': None,
  'ingest_date': '2019-02-22T20:02:12.562Z',
  'attributes': {'row_int': 32,
   'bucketName': 'landsat-pds',
   'productID': 'LC08_L1TP_033032_20190215_20190222_01_T1',
   'sensorPlatformName': 'LANDSAT08',
   'browseURL': 'https://s3-us-west-2.amazonaws.com/landsat-pds/c1/L8/033/032/LC08_L1TP_033032_20190215_20190222_01_T1/LC08_L1TP_033032_20190215_20190222_01_T1_thumb_large.jpg',
   'cloudCover_int': 7,
   'path_int': 33,
   'catalogID': 'LC80330322019046LGN00',
   'panResolution_dbl': 15.0,
   'vendor': 'Landsat',
   'bucketPrefix': 'c1/L8/033/032/LC08_L1TP_033032_20190215_20190222_01_T1',
   'platformName': 'LANDSAT08',
   'multiResolution_dbl': 30.0},
  'ingest_attributes': {'_rest_user': '',
   '_rest_url': 'http://vector.geobigdata.io/api/vectors/gbdx-alpha-catalog-v2-%257Bitem_date%253Ayyyy%257D'},
  'id': 'LC80330322019046LGN00',
  'source': None,
  'text': ''}}

Vector Response Example

JSON

[
    {
        "geometry": {
            "coordinates": [
                [
                    [
                        -105.138,
                        41.289
                    ],
                    [
                        -105.621,
                        39.69
                    ],
                    [
                        -103.412,
                        39.369
                    ],
                    [
                        -102.879,
                        40.96
                    ],
                    [
                        -105.138,
                        41.289
                    ]
                ]
            ],
            "type": "Polygon"
        },
        "type": "Feature",
        "properties": {
            "ingest_source": "GBDX_INGEST_ALPHA",
            "item_date": "2019-02-15T17:37:02.350Z",
            "original_crs": "EPSG:4326",
            "item_type": [
                "GBDXCatalogRecord",
                "Acquisition",
                "Landsat8",
                "LandsatAcquisition"
            ],
            "name": null,
            "format": null,
            "ingest_date": "2019-02-22T20:02:12.562Z",
            "attributes": {
                "row_int": 32,
                "bucketName": "landsat-pds",
                "productID": "LC08_L1TP_033032_20190215_20190222_01_T1",
                "sensorPlatformName": "LANDSAT08",
                "browseURL": "https://s3-us-west-2.amazonaws.com/landsat-pds/c1/L8/033/032/LC08_L1TP_033032_20190215_20190222_01_T1/LC08_L1TP_033032_20190215_20190222_01_T1_thumb_large.jpg",
                "cloudCover_int": 7,
                "path_int": 33,
                "catalogID": "LC80330322019046LGN00",
                "panResolution_dbl": 15,
                "vendor": "Landsat",
                "bucketPrefix": "c1/L8/033/032/LC08_L1TP_033032_20190215_20190222_01_T1",
                "platformName": "LANDSAT08",
                "multiResolution_dbl": 30
            },
            "ingest_attributes": {
                "_rest_user": "",
                "_rest_url": "http://vector.geobigdata.io/api/vectors/gbdx-alpha-catalog-v2-%257Bitem_date%253Ayyyy%257D"
            },
            "id": "LC80330322019046LGN00",
            "source": null,
            "text": ""
        }
    }
]

Catalog API Response Example

JSON

 {
            "identifier": "LC80330332018107LGN00",
            "type": [
                "GBDXCatalogRecord",
                "Acquisition",
                "Landsat8",
                "LandsatAcquisition"
            ],
            "properties": {
                "vendor": "Landsat",
                "timestamp": "2018-04-17T17:36:59.133Z",
                "browseURL": "https://s3-us-west-2.amazonaws.com/landsat-pds/c1/L8/033/033/LC08_L1TP_033033_20180417_20180501_01_T1/LC08_L1TP_033033_20180417_20180501_01_T1_thumb_large.jpg",
                "panResolution": 15.0,
                "bucketPrefix": "c1/L8/033/033/LC08_L1TP_033033_20180417_20180501_01_T1",
                "footprintWkt": "MULTIPOLYGON(((-106.04896 39.95419, -103.34129 39.94707, -103.38985 37.82843, -106.01824 37.83503, -106.04896 39.95419)))",
                "cloudCover": 0,
                "catalogID": "LC80330332018107LGN00",
                "bucketName": "landsat-pds",
                "path": 33,
                "sensorPlatformName": "LANDSAT08",
                "multiResolution": 30.0,
                "row": 33,
                "platformName": "LANDSAT08",
                "productID": "LC08_L1TP_033033_20180417_20180501_01_T1"
            }
        }

Back to top

Contact

If you have any questions or issues with this task, please contact [email protected].

Updated about a month ago

LANDSAT-8 (retired from GBDX)


DEC 14, 2020 This dataset has been removed from GBDX and is no longer available.

IMPORTANT: This imagery dataset has been deprecated from GBDX and will be removed from our platform on December 14, 2020. Read the deprecation announcement.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.