Compatibility Warnings

Product ID:

Instead of your Descartes Labs user ID, the product id is now prepended with your Descartes Labs organization ID if available, otherwise it defaults to your Descartes Labs user ID. If the prefix is your Descartes Labs organization ID, it means that your product id must be unique within your organization.

Image and Band Name:

The allowed characters are now a through z, A through Z, 0 through 9, ., _ and -. Note that : is not an allowed character any more.

Image and Band Owners:

The image and band owners will include the owners of the related product. This means that if you’re not the owner of the product (but you are the writer), you can add an image or band and the owners will not only include your Descartes Labs user ID but also the owners of the related product.

Catalog

The tables below list the types and functions available through the Catalog API. For information on how these objects work together, check out the Catalog Guide.

The Catalog Service provides access to products, bands, and images available from Descartes Labs.

Catalog Objects

CatalogClient

The CatalogClient handles the HTTP communication with the Descartes Labs catalog.

CatalogObject

A base class for all representations of objects in the Descartes Labs catalog.

NamedCatalogObject

A catalog object with a required name and product_id instead of id.

AttributeValidationError

There was a problem validating the corresponding attribute.

Product

Product

A raster product that connects band information to imagery.

Bands

Band

A data band in images of a specific product.

SpectralBand

A band that lies somewhere on the visible/NIR/SWIR electro-optical wavelength spectrum.

MicrowaveBand

A band that lies in the microwave spectrum, often from SAR or passive radar sensors.

MaskBand

A binary band where by convention a 0 means masked and 1 means non-masked.

ClassBand

A band that maps a finite set of values that may not be continuous.

GenericBand

A generic kind of band not fitting any other type.

DerivedBand

A type of band that is the result of a pixel function applied to one or more existing bands.

Resolution

A spatial pixel resolution with a unit.

Image

Image

An image with raster data.

ImageUpload

Request to upload an image.

File

File definition for an Image.

Search

Search

A search request that iterates over its search results.

ImageSearch

A search request that iterates over its search results.

SummaryResult

The readonly data returned by ImageSearch.summary() or ImageSearch.summary_interval().